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

Document use of checklists and draft PRs in developer docs #30

Closed
jtniehof opened this issue Sep 30, 2020 · 1 comment · Fixed by #50
Closed

Document use of checklists and draft PRs in developer docs #30

jtniehof opened this issue Sep 30, 2020 · 1 comment · Fixed by #50
Assignees
Labels
documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) enhancement New feature or feature request

Comments

@jtniehof
Copy link
Member

We use the PR checklist as a guide for things to check in a pull request, but this does mean it's shown on the PR list as (e.g.) "7/8 tasks completed", implying the PR is not done or not complete. Another way of indicating not complete is using a draft PR instead of ready-to-merge. We should document in the dev docs (probably the working with PRs thing) what standards we want: do we want the checkmarks always checked (and if not applicable, put "N/A" and check it off, or maybe delete it?) or just assume any PR not in draft state is mergeable, regardless of checkmarks?

Closure condition

This issue should be closed when: dev docs updated as described above.

@jtniehof jtniehof added documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) enhancement New feature or feature request labels Sep 30, 2020
@jtniehof
Copy link
Member Author

Examples of how people have gone about this in SpacePy: https://github.com/spacepy/spacepy/pulls?q=is%3Apr+is%3Aclosed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) enhancement New feature or feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant