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

Update Setup Documentation and Dev Dependencies #31

Merged
merged 9 commits into from
Aug 19, 2023

Conversation

kry0sc0pic
Copy link
Contributor

Added instructions on how to setup bot for developers using poetry and included some common commands needed during development using poetry.

Updated the dev dependencies to add missing package pyright. This will be needed for #30

@kry0sc0pic kry0sc0pic marked this pull request as draft July 22, 2023 05:58
Copy link
Contributor

@lmaotrigine lmaotrigine left a 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 Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
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`
Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok will update

Copy link
Contributor

@lmaotrigine lmaotrigine left a 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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
kry0sc0pic and others added 4 commits July 22, 2023 15:47
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>
Copy link
Contributor

@lmaotrigine lmaotrigine left a 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.

README.md Show resolved Hide resolved
@kry0sc0pic kry0sc0pic marked this pull request as ready for review July 22, 2023 13:16
@sinsniwal sinsniwal merged commit 2e776db into sinsniwal:main Aug 19, 2023
2 checks passed
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

Successfully merging this pull request may close these issues.

3 participants