Map Action Contribution Guidelines
Welcome to Map Action! We're excited about your interest in contributing to our open-source project. These guidelines will help you understand how to effectively contribute to our codebase.
About Map Action
Map Action is a Bamako-based trailblazer in using mapping technology to tackle environmental challenges and solve urban issues. Our innovative approach began by addressing Water, Sanitation, and Hygiene (WASH) problems and has grown to encompass various sectors through collaboration with civil society, governments, NGOs, and private entities.
Our sustainable business model includes paid subscriptions for organizations that rely on our data to gain actionable insights across diverse domains. This model allows us to continuously enhance our offerings.
Contributing
We welcome contributions of all shapes and sizes! Here are the different ways you can get involved:
Report bugs and request features: Identify any issues you encounter while using our tools. You can report them directly on GitHub Issues https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues.
Submit code changes: If you have improvements or new features in mind, you can contribute code by creating pull requests (PRs).
Write documentation or tutorials: Enhance our documentation to make it easier for others to understand and use our tools.
Help with code reviews and testing: Lend your expertise by reviewing pull requests submitted by others and assisting with testing efforts.
Finding Issues to Work On
Browse our issue tracker on GitHub Issues https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues to find existing issues.
Look for issues labeled "help wanted" or those categorized as bugs or enhancements that you're interested in tackling.
Making Changes
Fork the Repository:
Visit the Map Action project on GitHub: https://github.com/223MapAction
Click on the "Fork" button to create your own copy of the repository.
Create a Branch:
Clone your forked repository to your local machine.
Create a new branch for your specific changes.
Use a descriptive branch name that reflects your contribution (e.g., "fix-map-loading-bug").
Code and Commit:
Make your changes to the codebase.
Write clear and concise commit messages that describe your modifications.
Testing:
Ensure your changes don't introduce any regressions.
We use pytest and flake8 for testing. Make sure your code passes all tests before submitting a pull request.
Submitting Pull Requests
Push to Your Branch:
Once you're satisfied with your changes, push your local branch to your forked repository on GitHub.
Open a Pull Request:
Navigate to your forked repository on GitHub and go to the "Pull Requests" tab.
Click on "New pull request" and select the branch containing your changes.
Create a pull request with a clear and descriptive title and explanation of your modifications.
Mention any issues your pull request addresses.
Code Review:
Our internal code review process involves two Map Action developers.
They'll review your pull request and provide feedback or suggestions for improvement.
Merge:
Once your pull request is approved and any necessary changes are made, it will be merged into the main codebase.
Additional Notes
License: All our repositories use the GPL-3.0 license. Ensure your contributions comply with the license terms.
Code of Conduct: We value a respectful and inclusive environment. Please familiarize yourself with our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
Appreciation: We appreciate all contributions, regardless of their scope. Thank you for helping us improve Map Action!
We look forward to your contributions!
This tailored guide incorporates the information you provided, making it specific to the Map Action project and its contribution workflow.