Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add development and contribution guides in the README or repo wiki #1014

Closed
mxmaher opened this issue Jan 27, 2025 · 2 comments
Closed

Add development and contribution guides in the README or repo wiki #1014

mxmaher opened this issue Jan 27, 2025 · 2 comments

Comments

@mxmaher
Copy link

mxmaher commented Jan 27, 2025

It would be very helpful if the project has some kind of contribution and development guides in the README.
It should explicitly mention that the project uses poetry and that there's a devcontainers setup already existing, this would save some time and confusion for anyone who wish to contribute to this awesome project.
Also it would be great to mention that to test the UI there's an example project existing under the tests folder

For example:

## Development Guide
This project uses poetry for managing dependinces, local development envirnoment and packge build and release.
A devcontainers setup is also provided for a more quick and convenient local setup if you are used to it or wish to try it.

**Use the following commands to setup the project locally for the first time**

1. Install poetry if not already available on your system [install poetry](https://python-poetry.org/docs/#installation)
2. etc...
3. ........
@lukasvinclav
Copy link
Contributor

All of these is already in the documentation :-)

@mxmaher
Copy link
Author

mxmaher commented Jan 28, 2025

@lukasvinclav Thank you for pointing this out, I'll check it.

I think having a link to this section of the docs in the readme would be helpful and make it more accessible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants