|
1 | | -# Contributing |
| 1 | +Thanks for looking here! We'd love your help. The micro:bit project is only |
| 2 | +possible through contributions of companies and individuals around the world. |
2 | 3 |
|
3 | | -When contributing to this repository, please first discuss the change you wish to make via issue or any other method |
4 | | -with the maintainers of this repository before making a change. |
| 4 | +This project is managed on GitHub, and the best way to contribute is to jump in |
| 5 | +and fix/file issues. |
5 | 6 |
|
6 | | -Please note we have a code of conduct, please follow it in all your interactions with the project. |
| 7 | +https://github.com/microbit-foundation/ml-trainer |
7 | 8 |
|
8 | | -## Pull Request Process |
| 9 | +Significant features are best discussed first to make sure everyone is agreed |
| 10 | +on the best direction. |
9 | 11 |
|
10 | | -1. Ensure any install or build dependencies are removed and the tests using `npm run test` are running successfully. |
11 | | -2. Update the README.md with details of changes to the interface, this includes new environment |
12 | | - variables and useful file locations, if applicable. |
13 | | -3. Increase the version numbers in any examples files and the README.md to the new version that this |
14 | | - Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). |
15 | | -4. Create a pull request describing the changes you have made, as briefly as possible. Maintainers may require further |
16 | | - detail or request changes. Avoid changing lines of code, that are unrelated to the change to avoid unnecessary code |
17 | | - ownership changes, such as inserting trailing commas or semicolons. |
18 | | -5. The pull request will be merged when at least two maintainers has accepted the changes. |
19 | | - |
20 | | -Thank you for considering contributing to the project! |
21 | | - |
22 | | -## Code of Conduct |
23 | | - |
24 | | -Please see Micro:bit Educational Foundation's [code of conduct](https://microbit.org/safeguarding/) which outlines our expectations for all those that participate in the community and details on how to report any concerns and what would happen should breaches occur. |
25 | | - |
26 | | -### Our Pledge |
27 | | - |
28 | | -In the interest of fostering an open and welcoming environment, we as |
29 | | -contributors and maintainers pledge to making participation in our project and |
30 | | -our community a harassment-free experience for everyone, regardless of age, body |
31 | | -size, disability, ethnicity, gender identity and expression, level of experience, |
32 | | -nationality, personal appearance, race, religion, or sexual identity and |
33 | | -orientation. |
34 | | - |
35 | | -We stride to make learning an empowering experience for all and constantly weigh the balance between accessibility and |
36 | | -complexity on our platform. |
37 | | - |
38 | | -### Our Standards |
39 | | - |
40 | | -Examples of behavior that contributes to creating a positive environment |
41 | | -include: |
42 | | - |
43 | | -* Using welcoming and inclusive language |
44 | | -* Being respectful of differing viewpoints and experiences |
45 | | -* Gracefully accepting constructive criticism |
46 | | -* Focusing on the empowerment of learning |
47 | | -* Showing empathy towards other users or contributors |
48 | | - |
49 | | -Examples of unacceptable behavior by participants include: |
50 | | - |
51 | | -* The use of sexualized language or imagery and unwelcome sexual attention or |
52 | | - advances |
53 | | -* Trolling, insulting/derogatory comments, and personal or political attacks |
54 | | -* Public or private harassment |
55 | | -* Publishing others' private information, such as a physical or electronic |
56 | | - address, without explicit permission |
57 | | -* Other conduct which could reasonably be considered inappropriate in a |
58 | | - professional setting |
59 | | - |
60 | | -### Our Responsibilities |
61 | | - |
62 | | -Maintainers of ML-Machine have the responsibility of upholding code quality and interpreting the code of conduct and are |
63 | | -expected to make appropriate and fair decisions in response to behavior and changes. |
64 | | - |
65 | | -Maintainers have the right to remove, edit or reject any changes such as commits, code wiki edits and issues which are |
66 | | -not aligned with our pledge, standards or code of conduct, or to ban temporarily or permanently any contributor for |
67 | | -actions deemed inappropriate or harmful. |
| 12 | +The project uses [Prettier](https://prettier.io/) to format code so please |
| 13 | +check out their documentation and set it up with your code editor. |
0 commit comments