Skip to content

Contributor welcome notes

Gregory Brown edited this page Feb 20, 2015 · 18 revisions

Thanks for contributing to Prawn!

You're now able to commit directly to our repositories, but please keep these guidelines in mind:

  • Most incoming pull requests still needs to be reviewed from one of Prawn's maintainers, but contributors can help with the testing, tweaking, and merging of those requests as long as someone on the maintenance team has signed off on the work.

  • Contributors can create their own feature branches directly on PrawnPDF repositories, which will make it easier for other contributors and maintainers to make revisions to a pull request.

  • Contributors can and should update the CHANGELOG.md file on their feature branches each time a proposed change is made.

  • Contributors can revert any code that gets put into master or stable that is clearly broken in some way, without waiting for a review.

  • Contributors can directly merge fixes for any bugs that have a clear cause and an obvious solution, as long as decent tests are provided.

  • Contributors can freely merge documentation improvements and other kinds of "safe changes" that wouldn't require much discussion.

  • Prawn's maintainers are responsible for release management and also for making final decisions on things, but contributors can take a more active role in those discussions and help out in a supporting role as much as they'd like.

  • If in doubt about any of this, just ask us! These are not commandments, but instead just guidelines to keep us organized. We can tweak them over time.