doc: Documentation on setting up the environment #719
Conversation
Signed-off-by: joelrobin18 <[email protected]>
Signed-off-by: joelrobin18 <[email protected]>
SemyonSinchenko
left a comment
SemyonSinchenko
left a comment
There was a problem hiding this comment.
At first I want to say thank you for this contribution and interest to the project! I left a few comments, actually there are some easier ways to do some things. And it is my bad that project lacks the good contribution guide :(
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #719 +/- ##
==========================================
+ Coverage 86.06% 86.16% +0.09%
==========================================
Files 63 63
Lines 2907 2927 +20
Branches 327 320 -7
==========================================
+ Hits 2502 2522 +20
Misses 405 405 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: joelrobin18 <[email protected]>
SemyonSinchenko
left a comment
SemyonSinchenko
left a comment
There was a problem hiding this comment.
LGTM! Nice work, thank you @joelrobin18 !
|
I will try to finish #586 and some other minor updates this weekend. Then, next week, we can deploy the new documentation with this beautiful guide for new contributors! |
4 participants
What changes were proposed in this pull request?
Added a comprehensive Contributing-guide.md file that provides detailed instructions for setting up the project locally for development and testing purposes.
Why are the changes needed?
The project previously lacked documentation on how to set up the development environment locally, run tests, and contribute changes through pull requests. By introducing a comprehensive Contributing-guide.md, we provide step-by-step instructions for environment setup, dependency installation, testing, and the pull request workflow. This would ease the process of contribution for the new contributors.