chanzuckerberg / czi-oss-training

Training Materials for Good Open Source Citizenship
Creative Commons Attribution 4.0 International
11 stars 3 forks source link

Add good Issue/PR checklists #76

Open pavithraes opened 1 year ago

pavithraes commented 1 year ago

Originally from @jaimergp in #75:

I think the text would benefit from a little section on how to write good issues and/or pull request descriptions. Some projects might not enforce it but it's good citizenship to leave a papertrail of the context of the contribution, and backreferencing as needed. Of course, if the project has some guidelines, follow them, but in the absence of them, we can still strive to provide good examples of useful interactions (specially when doing git-archeology in the future!).

We can add a couple of checklists for authoring issues and PRs in this section: https://github.com/chanzuckerberg/czi-oss-training/blob/main/02-participating-in-oss/04-contributing-tips.md#getting-the-most-of-the-issue-trackers-