diff options
author | Dylan William Hardison <dylan@hardison.net> | 2018-03-05 01:59:42 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-03-05 01:59:42 +0100 |
commit | b76754821a57fb80e3d096a39fb9ff95d1d9a2d0 (patch) | |
tree | f550482a578131bdcfcec4e11bd0db8496ec13e0 | |
parent | cfb84c6899369ceeac12511e39693c5ed12f3b21 (diff) | |
download | bugzilla-b76754821a57fb80e3d096a39fb9ff95d1d9a2d0.tar.gz bugzilla-b76754821a57fb80e3d096a39fb9ff95d1d9a2d0.tar.xz |
no bug - add a contributing.md
-rw-r--r-- | CONTRIBUTING.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e3c3bd4a4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing to Bugzilla + +Bugzilla welcomes contribution from everyone. Here are the guidelines if you are +thinking of helping us: + +## Contributions + +Contributions to Bugzilla should be made in the form of GitHub pull requests. +Each pull request will be reviewed by a core contributor (someone with +permission to land patches) and either landed in the main tree or given +feedback for changes that would be required. All contributions should follow +this format, even those from core contributors. + +Should you wish to work on an issue, please claim it first by commenting on +the GitHub issue that you want to work on it. This is to prevent duplicated +efforts from contributors on the same issue. + +Head over to [BugsAhoy!](https://www.joshmatthews.net/bugsahoy/?bugzilla=1) +to find good tasks to start with. If you come across words or jargon that do +not make sense, please check [FIXME](FIXME) first. If +there's no matching entry, please make a pull request to add one with the +content `TODO` so we can correct that! + +See [`README.rst`](README.rst) for more information +on how to start working on Bugzilla. + +## Pull Request Checklist + +- Branch from the master branch and, if needed, rebase to the current master + branch before submitting your pull request. If it doesn't merge cleanly with + master you may be asked to rebase your changes. + +- Commits should be as small as possible, while ensuring that each commit is + correct independently (i.e., each commit should compile and pass tests). + +- If your patch is not getting reviewed or you need a specific person to review + it, you can @-reply a reviewer asking for a review in the pull request or a + comment, or you can ask for a review in `#bugzilla` on `irc.mozilla.org`. + +- Add tests relevant to the fixed bug or new feature. + +For specific git instructions, see [GitHub workflow 101](https://github.com/servo/servo/wiki/Github-workflow). + +## Conduct + +In all Bugzilla-related forums, we follow the +[Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/). + For escalation or moderation issues, please contact inclusion@bugzilla.org instead of inclusion@mozilla.com. + We will respond within 24 hours. + +## Communication + +Bugzilla contributors frequent the `#bugzilla` channel on [`irc.mozilla.org`](https://wiki.mozilla.org/IRC). + +You can also join the [`bugzilla-dev` mailing list](developers@bugzilla.org). |