|
| 1 | +# Contributing to FireForm |
| 2 | + |
| 3 | +First of all, thank you for considering contributing to FireForm! It's people like you that make FireForm a great tool for first responders. |
| 4 | + |
| 5 | +FireForm is a Digital Public Good (DPG) designed to reduce administrative overhead for firefighters and other emergency services. By contributing, you are helping us build a more efficient future for emergency response. |
| 6 | + |
| 7 | +## 🌈 Code of Conduct |
| 8 | + |
| 9 | +This project and everyone participating in it is governed by the [FireForm Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to juanalvvsanchez@gmail.com. |
| 10 | + |
| 11 | +## 🚀 How Can I Contribute? |
| 12 | + |
| 13 | +### Reporting Bugs |
| 14 | + |
| 15 | +Before creating bug reports, please check the [issues list](https://github.com/juanalvv/FireForm/issues) to see if the problem has already been reported. |
| 16 | + |
| 17 | +When you are creating a bug report, please include as many details as possible: |
| 18 | +* **Use a clear and descriptive title** for the issue to identify the problem. |
| 19 | +* **Use the bug report template** to ensure you include all the necessary information. |
| 20 | +* **Describe the exact steps which reproduce the problem** in as many details as possible. |
| 21 | +* **Explain which behavior you expected to see instead and why.** |
| 22 | +* **Include screenshots** if applicable. |
| 23 | + |
| 24 | +### Suggesting Enhancements |
| 25 | + |
| 26 | +If you have a great idea for FireForm, we'd love to hear it! Please open an issue and include: |
| 27 | +* **A clear and descriptive title.** |
| 28 | +* **A step-by-step description of the suggested enhancement** in as many details as possible. |
| 29 | +* **Explain why this enhancement would be useful** to the users. |
| 30 | + |
| 31 | +### Pull Requests |
| 32 | + |
| 33 | +1. Fork the repo and create your branch from `main`. |
| 34 | +2. If you've added code that should be tested, add tests. |
| 35 | +3. Ensure the test suite passes. |
| 36 | +4. Make sure your code lints. |
| 37 | +5. Issue that pull request! |
| 38 | + |
| 39 | +## 🛠️ Local Development Setup |
| 40 | + |
| 41 | +FireForm uses Docker and Docker Compose for development to ensure a consistent environment. |
| 42 | + |
| 43 | +### Prerequisites |
| 44 | + |
| 45 | +- [Docker](https://docs.docker.com/get-docker/) |
| 46 | +- [Docker Compose](https://docs.docker.com/compose/install/) |
| 47 | +- `make` (optional, but recommended) |
0 commit comments