Skip to content

Commit 74d031e

Browse files
committed
Add contributing guidelines
1 parent e82bade commit 74d031e

File tree

2 files changed

+104
-0
lines changed

2 files changed

+104
-0
lines changed

CONTRIBUTING.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Contributing to ThRasE
2+
3+
Thank you for your interest in contributing to ThRasE! This document provides guidelines for contributing to the project, reporting issues, and seeking support.
4+
5+
## Code of Conduct
6+
7+
We are committed to providing a welcoming and inclusive environment. Please be respectful and constructive in all interactions.
8+
9+
## How to Contribute
10+
11+
### Reporting Bugs
12+
13+
If you encounter a bug or unexpected behavior:
14+
15+
1. **Search existing issues** — Check the [GitHub Issues](https://github.com/SMByC/ThRasE/issues) to see if the problem has already been reported.
16+
2. **Create a new issue** — If not already reported, open a new issue with:
17+
- A clear, descriptive title
18+
- Steps to reproduce the problem
19+
- Expected vs. actual behavior
20+
- Your environment details (QGIS version, operating system, ThRasE version)
21+
- Screenshots or full error message if applicable
22+
- Sample data to replicate the issue (if possible)
23+
24+
### Suggesting Features
25+
26+
We welcome feature suggestions! To propose a new feature:
27+
28+
1. **Check existing issues** — Your idea may already be under discussion.
29+
2. **Open a feature request** — Create a new issue with the label `enhancement` and include:
30+
- A clear description of the proposed feature
31+
- The use case or problem it addresses
32+
- Any implementation ideas you may have
33+
34+
### Contributing Code
35+
36+
#### Getting Started
37+
38+
1. **Fork the repository** on GitHub
39+
2. **Clone your fork** locally:
40+
```bash
41+
git clone https://github.com/SMByC/ThRasE.git
42+
```
43+
3. **Create a branch** for your changes:
44+
```bash
45+
git checkout -b feature/your-feature-name
46+
```
47+
4. Run tests
48+
5. Open a pull request (PR) against `main`
49+
50+
#### Development Setup
51+
52+
ThRasE is a QGIS plugin. To set up your development environment:
53+
54+
1. Link or copy the `ThRasE` directory to your QGIS plugins folder:
55+
- **Linux**: `~/.local/share/QGIS/QGIS3/profiles/default/python/plugins/`
56+
- **Windows**: `%APPDATA%\QGIS\QGIS3\profiles\default\python\plugins\`
57+
- **macOS**: `~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins/`
58+
2. Restart QGIS and enable the plugin via `Plugins``Manage and Install Plugins…`
59+
3. (Optional) Install the [plugin reloader](https://plugins.qgis.org/plugins/plugin_reloader) for easier plugin development.
60+
61+
#### Running Tests
62+
63+
First, install the test dependencies using UV:
64+
65+
```bash
66+
uv sync --extra test
67+
```
68+
69+
Then run the test suite:
70+
71+
```bash
72+
uv run pytest tests/
73+
```
74+
75+
### Contributing Documentation
76+
77+
Documentation improvements are always welcome! You can:
78+
79+
- Fix typos or clarify existing documentation
80+
- Add examples or tutorials
81+
- Improve the user guide
82+
83+
Documentation source files are in the `docs/` directory and use Jupyter Book (MyST Markdown).
84+
85+
## Seeking Support
86+
87+
If you need help using ThRasE:
88+
89+
1. **Read the documentation** — Visit [https://smbyc.github.io/ThRasE](https://smbyc.github.io/ThRasE).
90+
2. **Check existing issues or open a new support issue** — Search to see if your question has already been answered. If not, create a new issue.
91+
92+
## Contact
93+
94+
For direct inquiries:
95+
96+
- **Xavier C. Llano** — <xavier.corredor.llano@gmail.com>
97+
98+
## License
99+
100+
By contributing to ThRasE, you agree that your contributions will be licensed under the [GNU General Public License v3.0](LICENSE).

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,7 @@ ThRasE was developed by the Forest and Carbon Monitoring System (SMByC) at the I
3333
- [SMByC-PDI team](https://github.com/SMByC) - Development support and testing
3434

3535
This project was fully funded by the SMByC-IDEAM, Colombia.
36+
37+
## Contributing
38+
39+
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md)

0 commit comments

Comments
 (0)