Skip to content
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

Add good Issue/PR checklists #76

Open
pavithraes opened this issue Sep 6, 2023 · 0 comments
Open

Add good Issue/PR checklists #76

pavithraes opened this issue Sep 6, 2023 · 0 comments
Labels

Comments

@pavithraes
Copy link
Collaborator

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-

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant