Thank you for your interest in contributing to DocMind AI! We appreciate your help in making this project even better.
- 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.
-
Fork the repository to your own GitHub account.
-
Clone the forked repository to your local machine:
git clone https://github.com/BjornMelin/docmind-ai.git cd docmind-ai
-
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 asfix/bug-description
orfeat/new-feature-name
) -
Make your changes to the code or documentation.
-
Commit your changes with clear and concise commit messages:
git commit -m "Fix: Resolve issue with PDF loading"
-
Push your branch to your forked repository:
git push origin feature/your-feature-name
-
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.
- 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.
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!