Skip to content

Commit

Permalink
Merge pull request #322 from larinam/patch-1
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md - information about running unit tests
  • Loading branch information
dartpain authored Sep 5, 2023
2 parents 4462e63 + b54d6fe commit 48e6bbd
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

### Testing
To run unit tests, from the root of the repository execute:
```
python -m pytest
```

### Workflow:
Create a fork, make changes on your forked repository, submit changes in a form of pull request
Create a fork, make changes on your forked repository, and submit changes in the form of a pull request.

## Questions / collaboration
## 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!🙏

1 comment on commit 48e6bbd

@vercel
Copy link

@vercel vercel bot commented on 48e6bbd Sep 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs-gpt – ./

docs-gpt-brown.vercel.app
docs-gpt-arc53.vercel.app
docs-gpt-git-main-arc53.vercel.app

Please sign in to comment.