Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 3.13 KB
Raw

Contribution Guidelines

Welcome to Chomu's contribution guidelines! We appreciate your interest in contributing to our AI writing and assistant companion. Please review the following guidelines to ensure a smooth and effective collaboration.

Types of Contributions

We welcome contributions in the following areas:

  • Bug Fixes: If you encounter any issues or bugs in Chomu, please report them by creating a detailed bug report. Include information about the issue, steps to reproduce it, and your system specifications.

  • Feature Additions: If you have ideas for new features or enhancements, feel free to share them. Provide detailed descriptions and use cases for better understanding.

  • Documentation Improvements: Help us enhance our documentation. Whether it's fixing a typo, adding examples, or creating new sections, every improvement is valuable.

  • Code Optimization: If you have suggestions for optimizing the existing codebase or improving performance, we're open to your insights.

Branch Naming Convention

When creating a new branch, please use the following prefixes to indicate the purpose of your contribution:

  • fix-issue-<issue-number>-<brief-description>: For bug fixes and issue-related changes.

    • Example: fix-issue-123-fix-login-error

  • feature-<brief-description>: For adding new features or enhancements.

    • Example: feature-voice-assistant

  • docs-<brief-description>: For documentation-related changes.

    • Example: docs-update-user-guide

  • optimize-<brief-description>: For code optimization and performance improvements.

    • Example: optimize-sentence-generation

Coding Conventions

  • Follow the existing coding style and conventions used in the project.
  • Write clear, concise, and well-commented code.
  • Ensure your code is readable and maintainable.
  • Test your changes thoroughly before submitting a pull request.

How to Contribute

  1. Fork the Repository: Fork the Chomu repository to your GitHub account.

  2. Create a Branch: Create a new branch following the branch naming convention mentioned above.

    git checkout -b fix-issue-123-fix-login-error

  3. Make Changes: Make your changes or additions in the newly created branch.

  4. Test Your Changes: Test your changes to ensure they work as expected and do not introduce any new issues.

  5. Commit Your Changes: Commit your changes with clear and descriptive commit messages.

    git commit -m "Fix login error for issue #123"

  6. Push Your Changes: Push your changes to your forked repository on GitHub.

    git push origin fix-issue-123-fix-login-error

  7. Open a Pull Request: Submit a pull request from your branch to the main Chomu repository. Provide a detailed description of your changes in the pull request.

Code Review Process

All submissions, including contributions by project members, are subject to code review. We appreciate your patience during this process and will work to get your changes merged as quickly as possible.

Thank you for considering contributing to Chomu! Your support helps make this project better for everyone.