Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.1 KB

Contributing to DocMind AI

Thank you for your interest in contributing to DocMind AI! We appreciate your help in making this project even better.

Ways to Contribute

  • Report Bugs: Submit detailed bug reports with steps to reproduce the issue.
  • Suggest Enhancements: Propose new features or improvements.
  • Improve Documentation: Help us make the documentation clearer and more comprehensive.
  • Submit Code: Contribute code by fixing bugs, implementing new features, or improving existing code.

How to Submit a Pull Request

  1. Fork the repository to your own GitHub account.

  2. Clone the forked repository to your local machine:

    git clone https://github.com/BjornMelin/docmind-ai.git
    cd docmind-ai
  3. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

    (Replace feature/your-feature-name with a descriptive branch name, such as fix/bug-description or feat/new-feature-name)

  4. Make your changes to the code or documentation.

  5. Commit your changes with clear and concise commit messages:

    git commit -m "Fix: Resolve issue with PDF loading"
  6. Push your branch to your forked repository:

    git push origin feature/your-feature-name
  7. Create a Pull Request (PR):

    • Go to the original DocMind AI repository on GitHub.
    • Click the "New Pull Request" button.
    • Select your forked repository and the branch you just pushed.
    • Provide a clear and descriptive title and detailed description of your changes in the PR.
    • Submit the pull request.

Development Guidelines

  • Follow the existing coding style and conventions used in the project.
  • Write clear and concise commit messages.
  • Thoroughly test your changes before submitting a PR.
  • Document your code appropriately.
  • Keep your PRs focused on a single issue or feature.

Code of Conduct

Please note that this project has a Code of Conduct. We expect all contributors to adhere to it.

We appreciate your contributions and look forward to reviewing your pull requests!