|
1 | | - |
2 | 1 | ## Welcome to the Mile Two contributing guide |
| 2 | + |
3 | 3 | Thanks for investing your time in contributing to our project! |
4 | 4 |
|
5 | | -Please keep our community approachable and respectable, by following a few standards. It is our goal to make participation in the Mile Two open-source community a harassment-free environment for everyone. |
| 5 | +Please keep our community approachable and respectable, by following a few standards. It is our goal to make participation in the Mile Two open-source community a harassment-free environment for everyone. |
6 | 6 |
|
7 | 7 | ## Our Standards (as co-oped from [Github's Contribution Code of Conduct](https://github.com/github/docs/blob/8a3e0900ce997078c46380765447afb372cbd39d/CODE_OF_CONDUCT.md) |
8 | | -__Examples of behavior that contributes to a positive environment for our community include__ |
9 | | -- Demonstrating empathy and kindness toward other people |
10 | | -- Being respectful of differing opinions, viewpoints, and experiences |
11 | | -- Giving and gracefully accepting constructive feedback |
12 | | -- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience |
13 | | -- Focusing on what is best not just for us as individuals, but for the overall community |
14 | | - |
15 | | -__Examples of unacceptable behavior include__ |
16 | | -- The use of sexualized language or imagery, and sexual attention or advances of any kind |
17 | | -- Trolling, insulting or derogatory comments, and personal or political attacks |
18 | | -- Public or private harassment |
19 | | -- Publishing others' private information (PII), such as a physical or email address, without their explicit permission |
20 | | -- Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, without their explicit permission |
21 | | -- Other conduct which could reasonably be considered inappropriate in a professional setting |
22 | 8 |
|
| 9 | +**Examples of behavior that contributes to a positive environment for our community include** |
| 10 | + |
| 11 | +- Demonstrating empathy and kindness toward other people |
| 12 | +- Being respectful of differing opinions, viewpoints, and experiences |
| 13 | +- Giving and gracefully accepting constructive feedback |
| 14 | +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience |
| 15 | +- Focusing on what is best not just for us as individuals, but for the overall community |
| 16 | + |
| 17 | +**Examples of unacceptable behavior include** |
| 18 | + |
| 19 | +- The use of sexualized language or imagery, and sexual attention or advances of any kind |
| 20 | +- Trolling, insulting or derogatory comments, and personal or political attacks |
| 21 | +- Public or private harassment |
| 22 | +- Publishing others' private information (PII), such as a physical or email address, without their explicit permission |
| 23 | +- Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, without their explicit permission |
| 24 | +- Other conduct which could reasonably be considered inappropriate in a professional setting |
23 | 25 |
|
24 | 26 | ## Getting Started |
25 | 27 |
|
26 | 28 | ### Issues |
| 29 | + |
27 | 30 | #### Create a new issue |
| 31 | + |
28 | 32 | If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form. |
29 | 33 |
|
30 | 34 | #### Solve an issue |
| 35 | + |
31 | 36 | Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. |
32 | 37 |
|
33 | 38 | ### Making Changes |
34 | 39 |
|
35 | 40 | #### Fork our repo |
36 | 41 |
|
37 | | -- Create a branch related to the issue you plan on working. |
| 42 | +- Create a branch related to the issue you plan on working. |
38 | 43 |
|
39 | 44 | ### Pull Requests |
40 | 45 |
|
41 | | -- Create a Pull Request from your `forked` repo's issue branch |
42 | | - - If there are review comments, update them |
43 | | - - Commit and push changes |
44 | | -- Reviewer merges your PR! |
| 46 | +- Prior to opening your pull request add yourself as a contributor |
| 47 | + |
| 48 | + ``` |
| 49 | + npm run contributors:add keonik doc |
| 50 | + ``` |
| 51 | +
|
| 52 | + where `keonik` is your github username and `doc` is the [type of contribution](https://allcontributors.org/docs/en/emoji-key) |
| 53 | +
|
| 54 | + Update all-contributors list |
| 55 | +
|
| 56 | + ``` |
| 57 | + npm run contributors:generate |
| 58 | + ``` |
45 | 59 |
|
46 | | -🥳 Hurray! You have contributed to our project! 🥳 |
| 60 | +- Create a Pull Request from your `forked` repo's issue branch |
| 61 | + - If there are review comments, update them |
| 62 | + - Commit and push changes |
| 63 | +- Reviewer merges your PR! |
47 | 64 |
|
| 65 | +🥳 Hurray! You have contributed to our project! 🥳 |
0 commit comments