Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3.33 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 3.33 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue or any other method with the maintainers of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed and the tests using npm run test are running successfully.
  2. Update the README.md with details of changes to the interface, this includes new environment variables and useful file locations, if applicable.
  3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  4. Create a pull request describing the changes you have made, as briefly as possible. Maintainers may require further detail or request changes. Avoid changing lines of code, that are unrelated to the change to avoid unnecessary code ownership changes, such as inserting trailing commas or semicolons.
  5. The pull request will be merged when at least two maintainers has accepted the changes.

Thank you for considering contributing to the project!

Code of Conduct

Please see Micro:bit Educational Foundation's code of conduct 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.

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

We stride to make learning an empowering experience for all and constantly weigh the balance between accessibility and complexity on our platform.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on the empowerment of learning
  • Showing empathy towards other users or contributors

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Maintainers of ML-Machine have the responsibility of upholding code quality and interpreting the code of conduct and are expected to make appropriate and fair decisions in response to behavior and changes.

Maintainers have the right to remove, edit or reject any changes such as commits, code wiki edits and issues which are not aligned with our pledge, standards or code of conduct, or to ban temporarily or permanently any contributor for actions deemed inappropriate or harmful.