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

More documentation of pull request processing; release notes #50

Merged
merged 5 commits into from Oct 28, 2020

Conversation

jtniehof
Copy link
Member

This PR adds an initial release notes setup (closes #28), including auto-generated list of closed issues/PRs. That issue contains some example of the output and I suspect we might want to tweak the formatting a bit; it's fairly coarse.

It documents how to mark a PR ready for review (closes #30).

And it documents the Github magic words (closes #29). I think "closes" is probably the preferred word here because "fixes" seems less applicable to e.g. enhancement, but I'm open to objections. I'm also open to saying we don't have a standard, just use a word that does the closing. I also documented using them in both the PR and the commit; I think it helps tie everything together, but open to changing that.

PR Checklist

  • Pull request has descriptive title
  • Pull request gives overview of changes
  • New code has inline comments where necessary
  • Any new modules, functions or classes have docstrings consistent with dbprocessing style
  • Major new functionality has appropriate Sphinx documentation
  • (N/A) Added an entry to CHANGELOG if fixing a major bug or providing a major new feature
  • (N/A) New features and bug fixes should have unit tests
  • Relevant issues are linked in the description (e.g. See issue # or Closes #)

This PR includes no dbprocessing functionality, but does include code to help prepare the release notes. That's to-standard although it doesn't have tests (it's not particularly testable code.)

@jtniehof jtniehof added the documentation Issues that can be addressed with docs (docstrings, sphinx, wiki) label Oct 27, 2020
@jtniehof
Copy link
Member Author

This doesn't address #40, although it's somewhat relevant, since that will involve both documentation and CI changes; I think that's better left in a separate PR instead of bloating this one more.

@dnadeau-lanl dnadeau-lanl merged commit b470f43 into spacepy:master Oct 28, 2020
@jtniehof jtniehof deleted the pr_documentation branch October 29, 2020 15:22
@jtniehof jtniehof mentioned this pull request Oct 29, 2020
3 tasks
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)
Projects
None yet
2 participants