-
Notifications
You must be signed in to change notification settings - Fork 8
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
Update Setup Documentation and Dev Dependencies #31
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First pass, if something is unclear, I'm happy to clarify.
README.md
Outdated
2. Modify `config.py` with your settings. | ||
3. Add the required secrets to `.env.example` | ||
4. Rename `.env.example` to `.env` | ||
5. Install `poetry` using `pip install poetry` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
don't recommend pip installation. The official docs state to use the official installer unless you know what you're doing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok will update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These exports are still incorrect
Co-authored-by: lmaotrigine <57328245+lmaotrigine@users.noreply.github.com>
Co-authored-by: lmaotrigine <57328245+lmaotrigine@users.noreply.github.com>
Co-authored-by: lmaotrigine <57328245+lmaotrigine@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, the requirements files are now out of date. Please run the export commands and push the changes.
Added instructions on how to setup bot for developers using
poetry
and included some common commands needed during development usingpoetry
.Updated the dev dependencies to add missing package
pyright
. This will be needed for #30