You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
23
23
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.
28
30
-->
29
31
30
32
# Summary of changes
31
33
32
34
<!--
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
35
37
against this summary to ensure that the PR does not include unintended changes.
36
38
37
39
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.
49
51
50
52
-[ ] Checked that there aren't other open pull requests for
51
53
the same change.
52
-
-[ ] Added tests for any changes that have a runtime impact.
53
54
-[ ] 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.
55
63
-[ ] Updated relevant documentation to avoid inaccuracies.
56
64
-[ ] Considered adding additional documentation.
57
-
-[ ] Considered adding an example in `./examples` for new features.
58
-
-[ ] Considered updating our changelog (`CHANGELOG.md`).
59
65
-[ ] 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),
60
66
so maintainers can fix minor issues and keep your PR up to date.
0 commit comments