Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.26 KB

CONTRIBUTE.md

File metadata and controls

32 lines (24 loc) · 1.26 KB

Contributing to osmon

Thank you for your interest in contributing to osmon! All contributions, whether code, bug reports, or feature suggestions, are greatly appreciated.

How Can I Contribute?

Reporting Bugs and Suggesting Features

  • If you encounter a bug or have an idea for a new feature, please create an issue in our GitHub repository.
  • Describe the bug or feature as detailed as possible to help us understand your intentions.

Creating Pull Requests

  • Fork the repository.
  • Create a new branch for your changes (git checkout -b my-new-feature).
  • Make your changes in the code.
  • Ensure code is well-formatted and follows the project's coding standards.
  • Commit your changes (git commit -am 'Add some feature').
  • Push to your fork (git push origin my-new-feature).
  • Submit a Pull Request to our repository.

Guidelines

  • Make sure your changes are well documented.
  • Add tests for new features.
  • Follow the established coding standards.

Coding and Testing

  • We encourage clear and understandable coding.
  • Unit tests are an essential part of development. Try to maintain high test coverage.

Questions?

If you have any questions or concerns, don't hesitate to ask. We are here to help!

Thank you for your contributions to the osmon project!