Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (33 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 3.06 KB
Raw

Contributing to FireForm

First of all, thank you for considering contributing to FireForm! It's people like you that make FireForm a great tool for first responders.

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.

NOTE: Before you contribute! Please note that this project is still under early development. Because of this you may find many bugs caused either by cases yet unaddressed that we are aware of. Reports on these bugs will be dismissed to remove clutter, so please don't feel discouraged if your issue is dismissed quickly, it just means we were already aware of the bug.

🌈 Code of Conduct

This project and everyone participating in it is governed by the FireForm Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to juanalvarez_san@protonmail.com.

🚀 How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issues list to see if the problem has already been reported.

When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Use the bug report template to ensure you include all the necessary information.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots if applicable.

Suggesting Enhancements

If you have a great idea for FireForm, we'd love to hear it! Please open an issue and include:

  • A clear and descriptive title.
  • A step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to the users.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Issues are not formally assigned. You are free to pick any open issue, work on it, and raise a PR directly. If multiple PRs address the same issue, the first one that actually fixes it generally gets preference. To avoid duplicating someone else's work, coordinate with other contributors on our Discord before starting.

💬 Community

Join our Discord server to ask questions, discuss issues, and coordinate work with other contributors: https://discord.gg/nBv5b6kF68

🛠️ Local Development Setup

See the Setup Guide for the full walkthrough: prerequisites, running the backend with Docker, testing endpoints via Swagger UI, day-to-day commands, and troubleshooting.

Before writing code, read the Project Structure guide — it explains how the codebase is organized and where new code should go.