Add guide for contributing code
mojavelinux opened this issue · 4 comments
mojavelinux commented
Add a guide that covers how to contribute code.
mojavelinux commented
We can borrow the setup from Asciidoctor.js. See https://github.com/asciidoctor/asciidoctor.js/blob/master/CONTRIBUTING-CODE.adoc
mojavelinux commented
The guide from Asciidoctor.js turned out to be too specific to apply in this case, so I ended up amending the CONTRIBUTION.adoc guide with lots more details, including details about the development process.
mojavelinux commented
The key is explain the preferred workflow so pull requests can be merged most efficiently and with the least amount of post-merge steps for the lead/maintainer to perform.
mojavelinux commented
We should probably cover what to do if the lead/maintainer asks you to rebase your changes. That always trips up contributions. Maybe step 7?