Skip to content

Latest commit

 

History

History
40 lines (20 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

40 lines (20 loc) · 2.04 KB
Raw

How to contribute to Battery Monitor

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.

  • If possible, use the relevant bug report templates to create the issue. Simply copy the content of the appropriate template into a .md file, make the necessary changes to demonstrate the issue, and paste the content into the issue description.

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.

  • Before submitting, please read the Contributing to Battery Monitor guide to know more about coding conventions and benchmarks.

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 Battery Monitor will generally not be accepted.

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

  • Suggest your change in the Github Issue and start writing code.

Do you have questions about the source code?

  • Ask any question about how to use Battery Monitor in the GitHub Issue.

Do you want to contribute to the documentation?

  • It's dead simple. Just give Pull Request.

Battery Monitor is a volunteer effort. We encourage you to pitch in and join the team!

Thanks! ❤️ ❤️ ❤️

Battery Monitor Team