Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (27 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

35 lines (27 loc) · 2.07 KB
Raw

Contributing to FIXAM

Thank you for your interest in contributing to FIXAM (Facilitating Issue eXchange for Accountable Municipalities)! FIXAM is a Digital Public Good, and community contributions are essential to ensuring its success, accessibility, and continued improvement.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please ensure your interactions remain respectful and inclusive.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue in the GitHub repository. Include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected vs. actual behavior.
  • Information about your environment (OS, Node.js version, browser, etc.).

Suggesting Enhancements

Have an idea to make FIXAM better? We'd love to hear it. Submit an issue detailing:

  • A clear and descriptive title.
  • The problem your enhancement solves.
  • A detailed explanation of your proposed solution or feature.

Submitting Pull Requests

  1. Fork the Repository: Start by forking the FIXAM repository to your own account.
  2. Clone the Fork: Clone it to your local machine.
  3. Create a Branch: Create a new branch for your feature or bug fix with a descriptive name (e.g., feature/add-new-export-format or fix/map-rendering-issue).
  4. Make Changes: Implement your changes. Ensure your code follows the existing style and conventions. Add comments where necessary.
  5. Test Your Changes: Verify that your changes do not break existing functionality. Run any relevant setup / tests locally.
  6. Commit: Write clear, concise commit messages outlining the "what" and "why" of your changes.
  7. Push & Pull Request: Push the branch to your fork and create a Pull Request against the main FIXAM repository. Provide a thorough description of your PR.

Development Setup

Please refer to the Setup Instructions section in the README.md to set up your local development environment.

Thank you for helping build a tool that empowers citizens and improves municipal accountability!