Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 2.33 KB

Contributing to MapSearchify 🚀

Welcome to MapSearchify, the innovative world mapping platform. We appreciate your interest in contributing to our open-source project. Your collaboration makes a significant impact on the project's growth and quality. To ensure a smooth contribution process, please follow the guidelines below.

📖 Table of Contents

🚀 Getting Started

To start contributing, follow these steps:

  1. Fork the MapSearchify repository.
  2. Clone your forked repository to your local machine:
git clone https://github.com/your-username/mapsearchify.git
  1. Create a new branch for your contribution:
git checkout -b feature/your-contribution
  1. Make your changes, commit them, and push to your forked repository.
  2. Open a pull request from your forked repository to the main MapSearchify repository, describing your changes and the issue you're addressing.

🤝 How Can You Contribute?

🐞 Reporting Bugs

If you come across a bug or any unexpected behavior, please help us by opening an issue. Be sure to include detailed information about the bug, steps to reproduce it, and your system environment.

💡 Enhancement Proposals

Do you have ideas to improve MapSearchify? We welcome enhancement proposals. Describe your idea and its potential impact on the project. We'll discuss it together.

💻 Code Contribution

Code contributions are the heart of our project. To contribute code:

  1. Make sure to follow the coding style and guidelines of MapSearchify.
  2. Write meaningful commit messages and ensure that your code is well-documented.
  3. Run tests if applicable.
  4. Open a pull request, and our team will review your changes.

📜 Code of Conduct

MapSearchify follows a Code of Conduct to ensure a welcoming and inclusive environment for all contributors. Please read and adhere to it.

📄 License

By participating in the MapSearchify project, you agree to the terms of our License. Your contributions are subject to this license, so make sure you're comfortable with it.