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
Create CONTRIBUTING.md #943
base: master
Are you sure you want to change the base?
Conversation
Creating a resource file for any developer who wants to contribute to this open-source project. Adding more details than what was already provided, giving a detailed walkthrough for newcomers on how to make changes in the code.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #943 +/- ##
=======================================
Coverage 56.43% 56.43%
=======================================
Files 196 196
Lines 15601 15601
Branches 558 558
=======================================
Hits 8804 8804
Misses 6543 6543
Partials 254 254
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
@blakeschafer I've already got a draft somewhere on my machine there's a discussion here about how we want the contribution flow to look like in the future. However, saying that I will read the contributed doc when I have time and maybe we can use it for the interim. Thanks for your contribution. |
@blakeschafer, thank you for creating this document! BTW, it would be great to put a link to this file in the Readme with some short description. |
I'd like to add that in case a contributor would like to pick some existing issue up for development, it makes sense to choose from issues with the project assigned (on the right side of the conversation thread) - this means that it was reviewed by maintainer(s) and confirmed to be useful for the project |
At the point, where the doc tells about the review of the existing issues, it would be useful to mention that if a contributor sees an issue with useful from his\her PoV feature proposal or a bug, he\she is struggling with, it would be a helpful contribution to like the 1st post of that issue in the conversation tab (the issue description) - in this way, maintainers could know which issues should take the priority. |
Adding a section in the README that links to this document is a great idea! And also, yes I think there should be a link to the discord in the contributing document. Thanks all for the feedback. |
Creating a resource file for any developer who wants to contribute to this open-source project. Adding more details than what was already provided, giving a detailed walkthrough for newcomers on how to make changes in the code.