Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

43 lines (28 loc) · 1.7 KB

Contributing

Contributions are welcome! Here's how you can help:

Code

  1. Fork the repository and clone your fork.

  2. Start coding!

    • Follow the code style guidelines.
    • Check your code works as expected and document any changes.

  3. Commit & push your changes to a new branch (not master, one change per branch)

    • Commit messages should:
      • Use the present tense
      • Have a title which begins with a capital letter
      • Be descriptive. (e.g. no Update main.c or Fix a problem)

  4. Once you are happy with your changes, submit a pull request.

    • Open the pull-request form.
    • Add a short description explaining briefly what you've done (or if it's a work-in-progress - what you need to do).
A pull-request is considered merge-able when:
  1. It works.
  2. It follows the code style.

Issues

If you experience an issue, we would like to know the details.

  1. Do a quick search on GitHub to check if the issue has already been reported.
  2. Open an issue and describe the issue you are having - you could include:
    • Screenshots
    • Ways you have tried to solve the issue, and whether they worked or not
    • Your BoneOS version

After reporting you should aim to answer questions or clarifications as this helps pinpoint the cause of the issue (if you don't do this your issue may be closed).