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

Documentation Changes for Git Usage, Branching Model, and Release Management #885

Merged

Conversation

robertbartel
Copy link
Contributor

Modifying and expanding documentation related to release management and new Git branching model.

Additions

  • New RELEASE_MANAGEMENT.md doc with details on release process

Changes

  • Modified GIT_USAGE.md appropriately for move to new branching model
  • Updated CONTRIBUTING.md with more practical, day-to-day usage and initial setup Git information

Testing

  1. None; doc updates only

Todos

  • The specifics for "testing and quality pre-release tasks" during the release process need to be decided upon and documented.
  • The exact process for peer reviewing changes made to release branches (e.g., bug fixes) during the release process needs to be decided upon and documented.

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist (automated report can be put here)

Target Environment support

  • Linux

@robertbartel robertbartel added the documentation Improvements or additions to documentation label Oct 3, 2024
Copy link
Contributor

@christophertubbs christophertubbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the documentation looks good to me. Thank you for working on it.

We may want to see about somehow advertising the gitpages view of it all. It looks like all the docs get compiled into it, so you get a good view of what you've contributed. Sure, it looks like it was styled in ye olde year of 2002 (probably was), but it's pretty nice to have all that information there.

@christophertubbs christophertubbs merged commit 31c860d into NOAA-OWP:master Oct 3, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation QA/QC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants