Add a code of conduct and contributing file.

This commit is contained in:
Jonathan Kingston 2017-06-23 14:22:26 +01:00
parent 2a3aa296c0
commit 30c55e093c
3 changed files with 44 additions and 2 deletions

3
CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,3 @@
# Code Of Conduct
This add-on follows the [Mozilla Community Participation Guidelines](https://www.mozilla.org/en-US/about/governance/policies/participation/) for our code of conduct.

35
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,35 @@
# Contributing
Everyone is welcome to contribute to containers. Reach out to team members if you have questions:
- IRC: #containers on irc.mozilla.org
- Email: containers@mozilla.com
## Filing bugs
If you find a bug with containers, please file a issue.
Check first if the bug might already exist: https://github.com/mozilla/testpilot-containers/issues
[Open an issue](https://github.com/mozilla/testpilot-containers/issues/new)
1. Visit about:support
2. Click "Copy raw data to clipboard" and paste into the bug. Alternatively copy the following sections into the issue:
- Application Basics
- Nightly Features (if you are in nightly)
- Extensions
- Experimental Features
3. Include clear steps to reproduce the issue you have experienced.
4. Include screenshots if possible.
## Sending Pull Requests
Patches should be submitted as pull requests. When submitting patches as PRs:
- You agree to license your code under the project's open source license (MPL 2.0).
- Base your branch off the current master (see below for an example workflow).
- Add both your code and new tests if relevant.
- Run npm test to make sure all tests still pass.
- Please do not include merge commits in pull requests; include only commits with the new relevant code.
See the main [README](./README.md) for information on prerequisites, installing, running and testing.

View file

@ -57,7 +57,6 @@ Check out the [Browser Toolbox](https://developer.mozilla.org/en-US/docs/Tools/B
4. `npm install -g shield-study-cli` 4. `npm install -g shield-study-cli`
5. `shield run . -- --binary Nightly` 5. `shield run . -- --binary Nightly`
### Building .xpi ### Building .xpi
To build a local testpilot-containers.xpi, use the plain [`jpm To build a local testpilot-containers.xpi, use the plain [`jpm
@ -79,6 +78,11 @@ add-on](https://addons.mozilla.org/en-US/developers/addon/containers-experiment/
### Testing ### Testing
TBD TBD
### Distributing ### Distributing
TBD TBD
### Links
- [Licence](./LICENSE.txt)
- [Contributing](./CONTRIBUTING.md)
- [Code Of Conduct](./CODE_OF_CONDUCT.md)