Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

48 lines (38 loc) · 2.75 KB
Raw

Contribution Guide for MotuS

Welcome to the MotuS open-source project!

A Table of Contents

How to Contribute

We appreciate your interest in contributing to MotuS!! Contributions from the community help make this project better. Here are some guidelines on how you can contribute:

Issue Reporting

If you encounter any bugs, have feature requests, or want to suggest improvements, please submit an issue on our GitHub repository. When submitting an issue, please provide as much detail as possible, including steps to reproduce the problem.

Pull Requests

We welcome pull requests for bug fixes, new features, and enhancements. To submit a pull request:

  1. Fork the Repository: Start by forking this repository (https://github.com/MotuS-Web/MotuS-Backend) to your own GitHub account.

  2. Clone the Repository: Clone the forked repository to your local machine using Git.

    git clone https://github.com/MotuS-Web/MotuS-Backend.git

  3. Create a Branch: Create a new branch on your local machine with a descriptive name for your contribution.

    git checkout -b feature/your-contribution

  4. Make Changes: Implement your changes or additions in the codebase according to your contribution.

  5. Test Your Changes: Ensure that all existing tests pass and write additional tests if necessary.

  6. Commit Your Changes: Commit your changes with clear and concise commit messages explaining what you have done.

  7. Push Your Changes: Push your changes from the local branch to your forked repository on GitHub.

    git push origin feature/your-contribution

  8. Submit a Pull Request (PR): Go back to https://github.com/MotuS-Web/MotuS-Backend in your web browser and click on "New Pull Request". Fill out the necessary details, including a clear description of your contribution, and submit the PR.

  9. Review Process: The maintainers will review and provide feedback on your pull request through comments on the PR page. Be responsive and make any requested changes if needed.

  10. Merge and Deployment: Once approved, one of our maintainers will merge your pull request into the main branch, and it will be deployed accordingly in future releases of MotuS.

Please note that by contributing code or other materials (such as documentation), you agree that these contributions will be licensed under our project's license terms specified in LICENSE and LICENSE_3rd.

Thank you for considering contributing!