Skip to content

Latest commit

 

History

History
63 lines (49 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

63 lines (49 loc) · 1.87 KB

Contributing

Contributing to ModularMap is appreciated. If you have any suggestions, please create an issue or a pull request. Read How to contribute for more information about setting up the project and contributing.

All contributions are welcome, including but not limited to:

  • New features (or feature improvements)
  • Feature requests (and new ideas)
  • Bug fixes
  • Code optimizations
  • Documentation improvements
  • Tests
  • Translations

Contributors are added to the CONTRIBUTORS.md file.

Any other question? Check out the Discord server or create an issue.

Code of Conduct

Please read the Code of Conduct before contributing.

How to contribute

  1. Fork the repository:

    Click the Fork button in the top right corner of the repository page. This will create a copy of the repository in your GitHub account.

  2. Clone your forked repository to your local machine:

    You can clone your forked repository in 3 ways:

    • Using HTTPS:
     git clone https://github.com/<your-username>/ModularMap.git
    • Using SSH:
    git clone git@github.com:<your-username>/ModularMap.git
    • Using GitHub CLI:
    gh repo clone <your-username>/ModularMap

  3. Create a new branch

  4. Make your changes

  5. Commit your changes

  6. Push your changes to your forked repository

  7. Create a pull request:

    • Go to the repository page on GitHub
    • Click the Pull requests tab
    • Click the New pull request button
    • Select the base repository and branch
    • Select your forked repository and branch
    • Click the Create pull request button

    Your pull request will be reviewed and merged if it meets the requirements.

  8. Great, that's it. Thanks for contributing!