Skip to content

Commit

Permalink
Merge pull request #306 from larinam/pytest-introduction
Browse files Browse the repository at this point in the history
Adapt documentation to existing tests.
  • Loading branch information
dartpain authored Aug 23, 2023
2 parents b2bfd7f + 47f62a8 commit 505e12c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ Please try to follow 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)
Currently we don't have any tests(which would be useful😉) but before submitting you PR make sure that after you ingested some test data its queryable
* 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

## 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 to contribute to DocsGPT!🙏
# Thank you so much for considering contributing to DocsGPT!🙏

1 comment on commit 505e12c

@vercel
Copy link

@vercel vercel bot commented on 505e12c Aug 23, 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.