Skip to content

Latest commit

 

History

History
52 lines (31 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

52 lines (31 loc) · 2.82 KB

Welcome to DocsGPT Contributing Guidelines

Thank you for choosing to contribute to DocsGPT! We are all very grateful!

We accept different types of contributions

📣 Discussions - Engage in conversations, start new topics, or help answer questions.

🐞 Issues - This is where we keep track of tasks. It could be bugs,fixes or suggestions for new features.

🛠️ Pull requests - Suggest changes to our repository, either by working on existing issues or adding new features.

📚 Wiki - This is where our documentation resides.

🐞 Issues and Pull requests

We value contributions in the form of discussions or suggestions. We recommend taking a look at existing issues and our roadmap.

If you're interested in contributing code, here are some important things to know:

We have a frontend built with React (Vite) and a backend in Python.

If you are looking to contribute to frontend (⚛️React, Vite):

  • The current frontend is being migrated from /application to /frontend with a new design, so please contribute to the new one.
  • Check out this milestone and its issues.
  • The Figma design can be found here.

Please try to follow the guidelines.

If you are looking to contribute to Backend (🐍 Python):

  • Review our issues and contribute to /application or /scripts (please disregard old ingest_rst.py ingest_rst_sphinx.py files; they will be deprecated soon).
  • All new code should be covered with unit tests (pytest). Please find tests under /tests folder.
  • Before submitting your Pull Request, ensure it can be queried after ingesting some test data.

Testing

To run unit tests from the root of the repository, execute:

python -m pytest

Workflow:

Fork the repository, make your changes on your forked version, and then submit those changes as a pull request.

Questions/collaboration

Feel free to join our Discord. We're very friendly and welcoming to new contributors, so don't hesitate to reach out.

Thank you so much for considering contributing to DocsGPT!🙏