Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (46 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

92 lines (46 loc) · 1.43 KB

Contributing to android-notify

Thanks for your interest in contributing to android-notify! Your help makes this project better for everyone. Whether you're fixing a bug, improving documentation, or adding new features, contributions of all sizes are welcome.

How to Contribute

  1. Fork the Repo

Create your own copy via the Fork button.

  1. Clone Locally
git clone https://github.com/Fector101/android_notify.git
cd android-notify
  1. Create a Branch
git checkout -b feature-or-fix-name
  1. Make Your Changes

Follow the existing coding style.

Test your changes where possible.

If it's a bug fix, try to include a test or log explanation.

  1. Commit Clearly
git commit -m "Fix: corrected NameError in service.py"
  1. Push and Open a PR
git push origin feature-or-fix-name

Go to GitHub and open a Pull Request to the main branch.

Code Guidelines

Keep code readable and consistent.

Avoid unnecessary dependencies.

Add comments for any non-obvious logic.

Use Logger where relevant for debugging output.

Dependencies

If you add a new dependency, make sure to:

Justify its use.

Add it to requirements.txt or your buildozer.spec if needed.

Need Help?

If you're unsure how to start or run into issues, feel free to:

Open an issue with your question or suggestion.

Drop a comment in a relevant thread.

Thanks again for helping improve android-notify! 💙