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 #37

Merged
merged 1 commit into from
Oct 15, 2024

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
  • New GIT_USAGE.md doc with more technical details on Git usage and new branching model

Changes

  • 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
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Windows
  • Linux
  • Browser

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

Updating contributing docs with more detail on Git usage, adding more
detailed Git branching and info page, and adding page detailing steps
for release management.
@robertbartel robertbartel added the documentation Improvements or additions to documentation label Oct 15, 2024
@christophertubbs christophertubbs merged commit 5803d94 into NOAA-OWP:master Oct 15, 2024
3 of 4 checks passed
@robertbartel robertbartel deleted the f/git_docs/main branch October 18, 2024 17:36
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants