-
Notifications
You must be signed in to change notification settings - Fork 5
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
chore: add readme #96
Conversation
Reviewer's Guide by SourceryThis pull request adds initial documentation for the proWES project, including a README, contribution guidelines, and basic project information. It also updates the CI to pin the pip version. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @JaeAeich - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
@uniqueg Please ignore the commits from the previous PR, this PR is on top of it so the CI don't fail. |
Maybe amend the description to say why you pinned the Pip version. Also, you could mention that you added a type hint (presumably because Mypy complained), updated the Docker Compose call (as required by recent versions) and restricted the FOCA version. |
@sourcery-ai review |
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.
Hey @JaeAeich - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Those were for the last PR (those files aren't here anymore) but still added them here too. |
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.
Fixed a type, now LGTM :)
* minor changes * pin pip version * chore: add readme * chore: review * chore: review * Update README.md --------- Co-authored-by: Alex Kanitz <[email protected]>
This PR is for README.
This PR was branched on top of last PR #95 which had some changes:
Summary by Sourcery
Documentation: