Skip to content

Latest commit

 

History

History
30 lines (16 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

30 lines (16 loc) · 1.7 KB
Raw

How to contribute to OLP-MBSD

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of OLP-MBSD will not be declined.

Do you intend to add a new feature or change an existing one?

  • Suggest your change and create a new issue, then start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

Do you want to contribute to the OLP-MBSD documentation?

  • You can contribute to the documentation by making it more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest version.