Contributing to Mapapi
Thank you for considering contributing to Mapapi! We welcome contributions from the community to help improve the project. Please take a moment to review this guide to ensure your contributions are aligned with our project goals.
Getting Started
- Fork the Repository: Start by forking the repository to your GitHub account.
- Clone the Repository: Clone your forked repository to your local machine.
git clone https://github.com/your-username/Mapapi.git
- Set Up the Development Environment: Follow the instructions in the
installation.md to set up your development environment.
Coding Standards
- Follow the existing code style and conventions.
- Write clear, concise, and descriptive commit messages.
- Ensure your code is well-documented and includes comments where necessary.
Submitting Issues
- Search for existing issues before submitting a new one to avoid duplicates.
- Provide a clear and detailed description of the issue.
- Include steps to reproduce the issue, if applicable.
Making Pull Requests
- Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/your-feature-name
- Make Changes: Implement your changes and commit them to your branch.
- Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name
- Submit a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and reference any related issues.
Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
Thank you for your contributions!