Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 2.56 KB

Contributing to MOSS

Thanks for considering contributing to our project! Here are some guidelines to help you get started.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please create an issue by following these steps:

  1. Check Existing Issues: Before creating a new issue, please check if there's already an issue addressing your concern.
  2. Create a New Issue: If no existing issue matches your concern, open a new issue.
    • Title: Provide a descriptive title.
    • Description: Include detailed information about the issue or feature request, steps to reproduce (if applicable), and any relevant screenshots or code snippets.

Making Changes

  1. Fork the Repository: Fork the repository to your own GitHub account.
  2. Create a Branch: Create a new branch for your changes.
    • Use a descriptive name for your branch, e.g., feature/add-new-feature or bugfix/fix-issue.
  3. Make Your Changes: Implement your changes in your branch.
  4. Write Tests: If applicable, write tests for your changes.
  5. Commit Your Changes: Write clear and descriptive commit messages.
    • Commit Message Format: Use the present tense. Example: Add new feature instead of Added new feature.

Submitting a Pull Request

  1. Push Your Branch: Push your branch to your forked repository.
  2. Open a Pull Request: Open a pull request (PR) to the main branch of the original repository.
    • Title: Provide a descriptive title for your PR.
    • Description: Include a detailed description of your changes, the motivation behind them, and any related issues.
  3. Review Process:
    • Automatic Checks: Your PR will undergo automated checks.
    • Review by Maintainers: Your PR will be reviewed by the maintainers. They may request changes or provide feedback.

Code of Conduct

Please note that this project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Additional Information

  • Human Verification: During PR reviews, we strive to ensure that any contributions (especially those generated using language models) are thoroughly reviewed and verified by human maintainers for accuracy and relevance.
  • Documentation: Ensure that your changes are well-documented. Update any relevant documentation in the project.
  • Contact: If you have any questions or need further assistance, feel free to contact us.

Acknowledgments

We appreciate your contributions and look forward to collaborating with you!