Skip to content

Commit fa45862

Browse files
committed
Add documentation to bring taskcluster repos closer to the Github recommended community standards
Added licensing info (MPL2), contribution suggestions, and a link to the Mozilla Community Participation Guidelines. Addresses https://bugzil.la/1408073 for this repo. Carrying-over review from taskcluster/taskcluster-tools#546
1 parent a3343d3 commit fa45862

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Mozilla Community Participation Guidelines
2+
3+
The most recent version of the Mozilla Community Participation Guideline can always be found here: https://www.mozilla.org/en-US/about/governance/policies/participation/

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to Contribute
2+
3+
We welcome pull requests from everyone. We do expect everyone to adhere to the [Mozilla Community Participation Guidelines][participation].
4+
5+
If you're trying to figure out what to work on, here are some places to find suitable projects:
6+
* [Good first bugs][goodfirstbug]: these are scoped to make it easy for first-time contributors to get their feet wet with Taskcluster code.
7+
* [Mentored bugs][bugsahoy]: these are slightly more involved projects that may require insight or guidance from someone on the Taskcluster team.
8+
* [Full list of open issues][issues]: everything else
9+
10+
If the project you're interested in working on isn't covered by a bug or issue, or you're unsure about how to proceed on an existing issue, it's a good idea to talk to someone on the Taskcluster team before you go too far down a particular path. You can find us in the #taskcluster channel on [Mozilla's IRC server][irc] to discuss. You can also simply add a comment to the issue or bug.
11+
12+
Once you've found an issue to work on and written a patch, submit a pull request. Some things that will increase the chance that your pull request is accepted:
13+
14+
* Follow our [best practices][bestpractices].
15+
* This includes [writing or updating tests][testing].
16+
* Write a [good commit message][commit].
17+
18+
Welcome to the team!
19+
20+
[participation]: https://www.mozilla.org/en-US/about/governance/policies/participation/
21+
[issues]: ../../issues
22+
[bugsahoy]: https://www.joshmatthews.net/bugsahoy/?taskcluster=1
23+
[goodfirstbug]: http://www.joshmatthews.net/bugsahoy/?taskcluster=1&simple=1
24+
[irc]: https://wiki.mozilla.org/IRC
25+
[bestpractices]: https://docs.taskcluster.net/docs/manual/design/devel/best-practices
26+
[testing]: https://docs.taskcluster.net/docs/manual/design/devel/best-practices/testing
27+
[commit]: https://docs.taskcluster.net/docs/manual/design/devel/best-practices/commits
28+

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Mozilla Public License Version 2.0
3535
means any form of the work other than Source Code Form.
3636

3737
1.7. "Larger Work"
38-
means a work that combines Covered Software with other material, in
38+
means a work that combines Covered Software with other material, in
3939
a separate file or files, that is not Covered Software.
4040

4141
1.8. "License"

0 commit comments

Comments
 (0)