What problems would this solve? =============================== New contributors would know contribution guidelines before they start work, rather than at the time of the pull request Who would use this? =================== New contributors What would users see? ===================== Contribution guidelines are spelled out in documentation What would users do? What would happen as a result? =================================================== Contributors start by reading existing bugs in bugzilla, annotate commits with "fix bug XXX", etc. Is there anything else we should know? ======================================
Here's an example of contribution documentation from Mozillians: http://mozillians.readthedocs.org/en/latest/contribute.html :jwhitlock, is that the sort of documentation you mean?
Yes. :groovecoder pointed me at https://github.com/mozilla/kuma/blob/master/CONTRIBUTING.md. I've opened a pull request at https://github.com/mozilla/web-platform-compat/pull/3 . We're trying to sync the contribution flow with the MDN standard, namely: 1. Open a bug 2. Make the code change in https://github.com/jwhitlock/web-platform-compat 3. Reference the bug in the commit message 4. Send a pull request to https://github.com/mozilla/web-platform-compat/pulls 5. :groovecoder reviews or assigns 6. Merge into the mozilla repo, which should annotate the bug. Should I be adding a comment and needs info to the bug at the same time I do the pull request?
Commit pushed to master at https://github.com/mozilla/web-platform-compat https://github.com/mozilla/web-platform-compat/commit/c880d5983003c33dfe19766f2e3bf69ccd5721ca fix bug 1074922 - Sync contribution docs w/ MDN