Skip to content

Commit 63b082c

Browse files
authored
docs: recommend making an issue before making an enhancement (RDFLib#2391)
Suggest that contributors first make an issue to get in principle agreement for pull requests before making the pull request. Enhancements can be controversial, and we may reject the enhancement sometimes, even if the code is good, as it may just not be deemed important enough to increase the maintenance burden of RDFLib. Other changes: - Updated the checklist in the pull request template to be more accurate to current practice. - Improved grammar and writing in the pull request template, contribution guide and developers guide.
1 parent cd0b442 commit 63b082c

File tree

3 files changed

+41
-24
lines changed

3 files changed

+41
-24
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+22-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--
22
Thank you for your contribution to this project. This project has no formal
3-
funding or full-time maintainers and relies entirely on independent
3+
funding or full-time maintainers, and relies entirely on independent
44
contributors to keep it alive and relevant.
55
66
This pull request template includes some guidelines intended to help
@@ -15,23 +15,25 @@ and ask.
1515
More detailed guidelines for pull requests are provided in our [developers
1616
guide](https://github.com/RDFLib/rdflib/blob/main/docs/developers.rst).
1717
18-
As a reminder, PRs that are smaller in size and scope will be reviewed and
19-
merged quicker, so please consider if your PR could be split up into more than
20-
one independent part before submitting it, no PR is too small. The maintainers
21-
of this project may also split up larger PRs into smaller more manageable PRs
22-
if they deem it necessary.
18+
PRs that are smaller in size and scope will be reviewed and merged quicker, so
19+
please consider if your PR could be split up into more than one independent part
20+
before submitting it, no PR is too small. The maintainers of this project may
21+
also split up larger PRs into smaller, more manageable PRs, if they deem it
22+
necessary.
2323
24-
PRs should be reviewed and approved by at least two people other than the
25-
author using GitHub's review system before being merged. Reviews are open to
26-
anyone, so please consider reviewing other open pull requests as this will also
27-
free up the capacity required for your PR to be reviewed.
24+
PRs should be reviewed and approved by at least two people other than the author
25+
using GitHub's review system before being merged. This is less important for bug
26+
fixes and changes that don't impact runtime behaviour, but more important for
27+
changes that expand the RDFLib public API. Reviews are open to anyone, so please
28+
consider reviewing other open pull requests, as this will also free up the
29+
capacity required for your PR to be reviewed.
2830
-->
2931

3032
# Summary of changes
3133

3234
<!--
33-
Briefly explain what changes the pull request is making and why. Ideally this
34-
should cover all changes in the pull request as the changes will be reviewed
35+
Briefly explain what changes the pull request is making and why. Ideally, this
36+
should cover all changes in the pull request, as the changes will be reviewed
3537
against this summary to ensure that the PR does not include unintended changes.
3638
3739
Please also explicitly state if the PR makes any changes that are not backwards
@@ -49,13 +51,17 @@ unsure about them, submit your PR as is and ask for help.
4951

5052
- [ ] Checked that there aren't other open pull requests for
5153
the same change.
52-
- [ ] Added tests for any changes that have a runtime impact.
5354
- [ ] Checked that all tests and type checking passes.
54-
- For changes that have a potential impact on users of this project:
55+
- If the change adds new features or changes the RDFLib public API:
56+
<!-- This can be removed if no new features are added and the RDFLib public API is
57+
not changed. -->
58+
- [ ] Created an issue to discuss the change and get in-principle agreement.
59+
- [ ] Considered adding an example in `./examples`.
60+
- If the change has a potential impact on users of this project:
61+
<!-- This can be removed if the changed does affect users of this project. -->
62+
- [ ] Added or updated tests that fail without the change.
5563
- [ ] Updated relevant documentation to avoid inaccuracies.
5664
- [ ] Considered adding additional documentation.
57-
- [ ] Considered adding an example in `./examples` for new features.
58-
- [ ] Considered updating our changelog (`CHANGELOG.md`).
5965
- [ ] Considered granting [push permissions to the PR branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork),
6066
so maintainers can fix minor issues and keep your PR up to date.
6167

docs/CONTRIBUTING.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# RDFLib Contributing Guide
22

33
Thank you for considering contributing to RDFLib. This project has no formal
4-
funding or full-time maintainers and relies entirely on independent contributors
5-
to keep it alive and relevant.
4+
funding or full-time maintainers, and relies entirely on independent
5+
contributors to keep it alive and relevant.
66

77
## Ways to contribute
88

@@ -47,6 +47,12 @@ Some ways in which you can contribute to RDFLib are:
4747
Contributions that involve changes to the RDFLib repository have to be made with
4848
pull requests and should follow the [RDFLib developers guide](./developers.rst).
4949

50+
For changes that add features or affect the public API of RDFLib, it is
51+
recommended to first open an issue to discuss the change before starting to work
52+
on it. That way you can get feedback on the design of the feature before
53+
spending time on it.
54+
5055
## Code of Conduct
5156

52-
All contributions to the project should be consistent with the [code of conduct](./CODE_OF_CONDUCT.md) adopted by RDFLib.
57+
All contributions to the project should be consistent with the [code of
58+
conduct](./CODE_OF_CONDUCT.md) adopted by RDFLib.

docs/developers.rst

+10-5
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ Pull Requests Guidelines
2323

2424
Contributions to RDFLib are made through pull requests (PRs).
2525

26+
For changes that add features or affect the public API of RDFLib, it
27+
is recommended to first open an issue to discuss the change before starting to
28+
work on it. That way you can get feedback on the design of the feature before
29+
spending time on it.
30+
2631
In general, maintainers will only merge PRs if the following conditions are
2732
met:
2833

@@ -47,19 +52,19 @@ met:
4752
workflow pass.
4853

4954
In addition to these conditions, PRs that are easier to review and approve will
50-
be processed quicker. The primary factors that determine this is the scope and
51-
size of a PR. If there are few changes and the scope is limited then there is
55+
be processed quicker. The primary factors that determine this are the scope and
56+
size of a PR. If there are few changes and the scope is limited, then there is
5257
less that a reviewer has to understand and less that they can disagree with. It
53-
is thus important to try and split up your changes into multiple independent
54-
PRs if possible. No PR is too small.
58+
is thus important to try to split up your changes into multiple independent PRs
59+
if possible. No PR is too small.
5560

5661
For PRs that introduce breaking changes, it is even more critical that they are
5762
limited in size and scope, as they will likely have to be kept up to date with
5863
the ``main`` branch of this project for some time before they are merged.
5964

6065
It is also critical that your PR is understandable both in what it does and why
6166
it does it, and how the change will impact the users of this project, for this
62-
reason it is essential that your PR's description explains the nature of the
67+
reason, it is essential that your PR's description explains the nature of the
6368
PR, what the PR intends to do, why this is desirable, and how this will affect
6469
the users of this project.
6570

0 commit comments

Comments
 (0)