Skip to main content

Contributing

Contributions to OSAPI are very welcome, but we ask that you read this document before submitting a PR.

note

This document applies to the OSAPI repository.

Before you start​

  • Read the Development guide for prerequisites, setup, code style, testing, and commit message conventions.
  • Check existing work - Is there an existing PR? Are there issues discussing the feature/change you want to make? Please make sure you consider/address these discussions in your work.
  • Backwards compatibility - Will your change break existing OSAPI files? It is much more likely that your change will merged if it backwards compatible. Is there an approach you can take that maintains this compatibility? If not, consider opening an issue first so that API changes can be discussed before you invest your time into a PR.

Making changes​

  • Code style - Follow the conventions described in the Development guide.
  • Documentation - Ensure that you add/update any relevant documentation.
  • Tests - Ensure that you add/update any relevant tests and that all tests are passing before submitting the PR. See Development for how to run tests.

Submitting a PR​

  • Describe your changes - Ensure that you provide a comprehensive description of your changes.
  • Issue/PR links - Link any previous work such as related issues or PRs. Please describe how your changes differ to/extend this work.
  • Examples - Add any examples or screenshots that you think are useful to demonstrate the effect of your changes.
  • Draft PRs - If your changes are incomplete, but you would like to discuss them, open the PR as a draft and add a comment to start a discussion. Using comments rather than the PR description allows the description to be updated later while preserving any discussions.

FAQ​

I want to contribute, where do I start?

All kinds of contributions are welcome, whether its a typo fix or a shiny new feature. You can also contribute by upvoting/commenting on issues or helping to answer questions.

I'm stuck, where can I get help?

If you have questions, feel free open a Discussion on GitHub.