mirror of
https://github.com/pablorevilla-meshtastic/meshview.git
synced 2026-10-31 03:01:58 +01:00
44 lines
1.2 KiB
Markdown
44 lines
1.2 KiB
Markdown
# Contributing to Meshview
|
|
|
|
Thanks for helping improve Meshview. Bug reports, fixes, documentation updates, and feature ideas are welcome.
|
|
|
|
## Be Respectful
|
|
|
|
Keep discussion constructive and focused on the project. Harassment, personal attacks, hate speech, or sharing private information are not acceptable.
|
|
|
|
## Questions and Issues
|
|
|
|
Before opening a new issue, please search the existing issues first.
|
|
|
|
For bugs, include:
|
|
- what you expected to happen
|
|
- what actually happened
|
|
- steps to reproduce
|
|
- OS, Python version, database type, and useful logs
|
|
|
|
For feature requests, describe the use case and why it helps Meshview users.
|
|
|
|
Security issues should not be reported in public issues. Email them to **meshview-maintainers@proton.me**.
|
|
|
|
## Pull Requests
|
|
|
|
Use the `develop` branch for development work.
|
|
|
|
1. Fork and clone the repository.
|
|
2. Create your branch from `develop`.
|
|
3. Make your changes.
|
|
4. Test the app locally.
|
|
5. Commit and push your branch.
|
|
6. Open a pull request against `develop`.
|
|
|
|
For Python changes, run:
|
|
|
|
```bash
|
|
./env/bin/ruff check .
|
|
./env/bin/ruff format .
|
|
```
|
|
|
|
## Contribution Terms
|
|
|
|
By contributing, you confirm that you wrote the contribution or have the right to submit it, and that it can be provided under this project's license.
|