From b54d6fea4417a5d3d50ee82e0a64bc5b961fb94c Mon Sep 17 00:00:00 2001 From: Anton Larin Date: Tue, 5 Sep 2023 06:31:27 +0200 Subject: [PATCH] Update CONTRIBUTING.md - information about running unit tests --- CONTRIBUTING.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b2d82e29..eb136480 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,34 +6,39 @@ Thank you for choosing this project to contribute to, we are all very grateful! πŸ“£ Discussions - where you can start a new topic or answer some questions -🐞 Issues - Is how we track tasks, sometimes its bugs that need fixing, sometimes its new features +🐞 Issues - This is how we track tasks, sometimes it is bugs that need fixing, and sometimes it is new features -πŸ› οΈ Pull requests - Is how you can suggest changes to our repository, to work on existing issue or to add new features +πŸ› οΈ Pull requests - This is how you can suggest changes to our repository, to work on existing issues or add new features πŸ“š Wiki - where we have our documentation ## 🐞 Issues and Pull requests -We value contributions to our issues in form of discussion or suggestion, we recommend that you check out existing issues and our [Roadmap](https://github.com/orgs/arc53/projects/2) +We value contributions to our issues in the form of discussion or suggestion, we recommend that you check out existing issues and our [Roadmap](https://github.com/orgs/arc53/projects/2) -If you want to contribute by writing code there are few things that you should know before doing it: +If you want to contribute by writing code there are a few things that you should know before doing it: We have frontend (React, Vite) and Backend (python) ### If you are looking to contribute to Frontend (βš›οΈReact, Vite): -Current frontend is being migrated from /application to /frontend with a new design, so please contribute to the new on. Check out this [Milestone](https://github.com/arc53/DocsGPT/milestone/1) and its issues also [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1) -Please try to follow guidelines - +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](https://github.com/arc53/DocsGPT/milestone/1) and its issues also [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1) +Please try to follow the guidelines. ### If you are looking to contribute to Backend (🐍Python): * Check out our issues, and contribute to /application or /scripts (ignore old ingest_rst.py ingest_rst_sphinx.py files, they will be deprecated soon) * All new code should be covered with unit tests ([pytest](https://github.com/pytest-dev/pytest)). Please find tests under [/tests](https://github.com/arc53/DocsGPT/tree/main/tests) folder. * Before submitting your PR make sure that after you ingested some test data it is queryable. -### Workflow: -Create a fork, make changes on your forked repository, submit changes in a form of pull request +### Testing +To run unit tests, from the root of the repository execute: +``` +python -m pytest +``` -## Questions / collaboration +### Workflow: +Create a fork, make changes on your forked repository, and submit changes in the form of a pull request. + +## Questions/collaboration Please join our [Discord](https://discord.gg/n5BX8dh8rU) don't hesitate, we are very friendly and welcoming to new contributors. # Thank you so much for considering contributing to DocsGPT!πŸ™