docs (sunbase-py) updated setup instructions, PR guidelines, added resources & links #690
Conversation
Added setup instructions and resources, links to community spaces, specified issue and request guidelines, gave instructions on linking issues/PRs
brielle5810
requested review from
olirice,
J0 and
silentworks
as code owners
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Documentation
PR Summary: This pull request introduces a comprehensive update to the documentation, aimed at improving the onboarding experience for new contributors. It includes detailed setup instructions for a local development environment, links to relevant resources for Python, conda, and poetry, and guidelines for contributing, such as how to file issues and feature requests, and how to link issues or PRs in descriptions. The changes are designed to make the repository more accessible and to streamline the contribution process.
Decision: Comment
📝 Type: 'Documentation' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.
General suggestions:
- Consider integrating direct links to external resources (e.g.,
poetryandcondadocumentation) within the text where these tools are first mentioned to provide immediate access and improve the user experience. - Review the document for typographical errors to maintain professionalism and clarity in the documentation. For example, correcting 'deature requests' to 'feature requests'.
- Ensure consistency in verb-subject agreement within the documentation to enhance readability. For instance, changing 'are' to 'is' in the context of contributing to the Python libraries.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
Fixed a typo of the word feature
Changed GitHub Discussions link to the main Github discussions since the other will be discontinued
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #690 +/- ##
=======================================
Coverage 44.17% 44.17%
=======================================
Files 13 13
Lines 326 326
=======================================
Hits 144 144
Misses 182 182 ☔ View full report in Codecov by Sentry. |
|
@brielle5810 Thank you for your contribution in making this project better for everyone wanting to contribute. |
What kind of change does this PR introduce?
Docs update:
What is the current behavior?
Missing potentially helpful information for new contributors.
What is the new behavior?
Improved the onboarding experience for new contributors by including more relevant and helpful information/instructions, resources, and guidelines.
Additional context
N/A