Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: recommend making an issue before making an enchancement #2391

Merged

Conversation

aucampia
Copy link
Member

Summary of changes

Suggest that contributors first make an issue to get in principle agreement for pull requests before making the pull request.

Enhanements can be controvarsial 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 burder of RDFLib.

Checklist

  • Checked that there aren't other open pull requests for
    the same change.
  • Added tests for any changes that have a runtime impact.
  • Checked that all tests and type checking passes.
  • Considered granting push permissions to the PR branch,
    so maintainers can fix minor issues and keep your PR up to date.

@aucampia aucampia force-pushed the aucampia/20230519T1058-enhancement_guidance branch from 4bbb9c3 to b68c41e Compare May 19, 2023 09:50
@aucampia aucampia marked this pull request as ready for review May 19, 2023 09:51
@aucampia aucampia requested a review from a team May 19, 2023 09:51
@aucampia aucampia added review wanted This indicates that the PR is ready for review ready to merge The PR will be merged soon if no further feedback is provided. documentation Improvements or additions to documentation labels May 19, 2023
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.
@aucampia aucampia force-pushed the aucampia/20230519T1058-enhancement_guidance branch from b68c41e to 3f3b638 Compare May 19, 2023 09:58
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well worth making it clear and explicit 👍

@coveralls
Copy link

Coverage Status

Coverage: 90.854%. Remained the same when pulling 3f3b638 on aucampia:aucampia/20230519T1058-enhancement_guidance into e103078 on RDFLib:main.

@aucampia aucampia merged commit 63b082c into RDFLib:main May 19, 2023
25 checks passed
@aucampia aucampia deleted the aucampia/20230519T1058-enhancement_guidance branch June 8, 2023 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready to merge The PR will be merged soon if no further feedback is provided. review wanted This indicates that the PR is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants