diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..2fb0cb6 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0681439 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index c3aa7ed..027dc58 100644 --- a/README.md +++ b/README.md @@ -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` 5. `shield run . -- --binary Nightly` - ### Building .xpi 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 TBD - ### Distributing TBD + +### Links + +- [Licence](./LICENSE.txt) +- [Contributing](./CONTRIBUTING.md) +- [Code Of Conduct](./CODE_OF_CONDUCT.md)