mirror of
https://github.com/eddieoz/LoRa-Mesh-Analyzer.git
synced 2026-03-28 17:42:59 +01:00
41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
# Contributing to LoRa Mesh Analyzer
|
|
|
|
Thank you for your interest in contributing to the LoRa Mesh Analyzer! We welcome contributions from the community.
|
|
|
|
## How to Contribute
|
|
|
|
1. **Fork the repository**: Click the "Fork" button on the top right of the repository page.
|
|
2. **Clone your fork**:
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/LoRa-Mesh-Analyzer.git
|
|
cd LoRa-Mesh-Analyzer
|
|
```
|
|
3. **Create a branch**:
|
|
```bash
|
|
git checkout -b feature/my-new-feature
|
|
```
|
|
4. **Make your changes**: Implement your feature or fix.
|
|
5. **Run tests**: Ensure all tests pass.
|
|
```bash
|
|
pytest
|
|
```
|
|
6. **Commit your changes**:
|
|
```bash
|
|
git commit -am 'Add some feature'
|
|
```
|
|
7. **Push to the branch**:
|
|
```bash
|
|
git push origin feature/my-new-feature
|
|
```
|
|
8. **Submit a Pull Request**: Open a PR on the main repository.
|
|
|
|
## Coding Standards
|
|
|
|
- Follow PEP 8 style guidelines for Python code.
|
|
- Ensure code is well-documented.
|
|
- Add tests for new features.
|
|
|
|
## Reporting Issues
|
|
|
|
If you find a bug or have a feature request, please open an issue on the GitHub repository.
|