Repository navigation
Suggestions to update the contribution guide #766
Description
I have been navigating Thor's codebase as I am working on #666. I am still trying to fully understand how the pieces work together before building the feature.
The current contribution document doesn't help much. It would be helpful to have an extensive guide that covers the following:
- Dev environment setup
- Coding Conventions
- Running tests
- A high level overview of the codebase(entry point + common scenarios to consider when adding a new feature etc.).
- How to contribute to documentation ( report bugs properly, update the wiki and the website content etc.).
I love Thor and I am definitely interested in working on the contribution guide as it will help tackle issues faster and welcome new contributors to the project. What are your thoughts? Thanks!
Activity
dorner commentedon Jan 8, 2022
We're happy for any contributions! Give it a whirl and we'll review!
patrick-motard commentedon Jan 13, 2022
@azzenabidi I am interested in trying out whatever you end up writing up. I've submitted an issue that I would like to fix. I also would like to nudge along the many open PRs on this project. From the sounds of it, this project could use some love. Any efforts to ease the onboarding process would go a long way.
azzenabidi commentedon Jan 13, 2022
@patrick-motard Glad to hear that! I am making progress with the guide. If everything goes well, I will be opening a pull request next week :) cc @dorner
dorner commentedon Jan 13, 2022
Nice, looking forward!