Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 3.51 KB

Contributing to Chat with Your Docs

Thank you for considering contributing to Chat with Your Docs! We appreciate your interest in improving and enhancing our project. By contributing, you can help make Chat with Your Docs even better for all users. Below are the guidelines for contributing to this project.

Code of Conduct

Before getting started, please read and adhere to our Code of Conduct. We expect all contributors to follow these guidelines to maintain a welcoming and inclusive community.

Ways to Contribute

There are several ways you can contribute to Chat with Your Docs:

  1. Reporting Issues: If you encounter any bugs or have suggestions for improvements, please submit an issue on our GitHub Issues page.

  2. Fixing Bugs: If you identify a bug and know how to fix it, feel free to submit a pull request with the proposed changes.

  3. Adding Features: If you have an idea for a new feature or enhancement, we welcome your contributions. You can submit a pull request with the proposed feature.

  4. Documentation: If you notice any areas where the documentation could be improved or clarified, please submit a pull request to update it.

Getting Started

To contribute to Chat with Your Docs, follow these steps:

  1. Fork the Repository: Start by forking the Chat with Your Docs repository to your GitHub account.

  2. Clone the Repository: Clone the forked repository to your local development environment using the following command:

    git clone https://github.com/your-username/Chat-with-Your-Docs.git

  3. Create a Branch: Create a new branch for your contribution. Give the branch a descriptive name that reflects the changes you intend to make.

  4. Make Changes: Make the necessary changes and improvements in your branch. Ensure that your code adheres to the project's coding style and guidelines.

  5. Commit Messages: Write clear and concise commit messages that describe the purpose of each commit. Please follow the standard commit message format:

    type(scope): commit message

    For example:

    • feat(search): Add fuzzy search feature
    • fix(bug): Fix issue with search results

    The allowed commit types are:

    • feat: For new features or enhancements
    • fix: For bug fixes
    • chore: For maintenance tasks or other non-functional changes
    • docs: For documentation updates
    • style: For code style changes (e.g., formatting, whitespace)
    • refactor: For code refactoring or restructuring
    • test: For adding or updating tests

  6. Testing: If applicable, ensure that your changes include appropriate tests and that all existing tests pass. (Testing suite coming soon)

  7. Push Changes: Push your changes to your forked repository.

  8. Submit Pull Request: Once your changes are ready, submit a pull request from your branch to the main repository's main branch. Provide a clear description of your changes in the pull request.

  9. Code Review: Your pull request will be reviewed by the maintainers. Address any feedback or comments as necessary.

  10. Merge: Once your pull request is approved, it will be merged into the main repository.

License

By contributing to Chat with Your Docs, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Chat with Your Docs! Your efforts help make this project better for everyone.