Skip to content

Contributing and Release Guidelines

Jump to bottom Edit New page
Tyler Porter edited this page Aug 31, 2022 · 1 revision

Contributors

Development

Typically, development happens on downstream clones and PRs are opened against the dev branch here. PRs that address an issue are encouraged to include this in the PR description. Additionally, adding appropriate labels to your PR is also highly suggested.

⚠️ You may be asked to alter or close your PR if it is pointed to another branch.

Good PR examples:

dev Branch

dev is kept up-to-date with latest master following each new release.

This branch typically has a long-running PR opened against master, which will be marked as pre-release and includes all the changes that will go out with the next release.

If the next release number is reasonably well-defined, the PR name will also include this estimation.

Maintainers

ℹ️ The following section is intended for users that have repo write access and do not apply to all contributors.

Release Procedure

Before releasing, it's important to check out the latest pre-release dev branch and perform a manual regression test to ensure there are no unhandled exceptions. Also consider testing any known new features if possible.

  • Create a new release with the appropriate version number (adding a short description in the title is optional -- see examples)
    • Target the dev branch, not master
    • Create a tag with the version number if not already completed
  • Merge dev into master
  • Create a PR for master -> dev, and merge it
  • Finally, create a new dev -> master PR, add the appropriate release title and estimated version number, and label it as pre-release

Release Examples:

Add a custom footer
Add a custom sidebar
Clone this wiki locally