Skip to content
This repository has been archived by the owner on May 9, 2024. It is now read-only.

Latest commit

 

History

History
41 lines (26 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 3.54 KB
Raw

Contributing and Maintaining

First, thank you for taking the time to contribute!

The following is a set of guidelines for contributors as well as information and instructions around our maintenance process. The two are closely tied together in terms of how we all work together and set expectations, so while you may not need to know everything in here to submit an issue or pull request, it's best to keep them in the same document.

Ways to contribute

Contributing isn't just writing code - it's anything that improves the project. All contributions are managed right here on GitHub. Here are some ways you can help:

Reporting bugs

If you're running into an issue, please take a look through existing issues and open a new one if needed. If you're able, include steps to reproduce, environment information, and screenshots/screencasts as relevant.

Suggesting enhancements

New features and enhancements are also managed via issues.

Pull requests

Pull requests represent a proposed solution to a specified problem. They should always reference an issue that describes the problem and contains discussion about the problem itself. Discussion on pull requests should be limited to the pull request itself, i.e. code review.

For more on how 10up writes and manages code, check out our 10up Engineering Best Practices.

Workflow

The develop branch is the development branch which means it contains the next version to be released. stable contains the current latest release and master contains the corresponding stable development version. Always work on the develop branch and open up PRs against develop.

Release instructions

  1. Branch: Starting from develop, cut a release branch named release/X.Y.Z for your changes.
  2. Version bump: Bump the version number in package.json, package-lock.json, and any other relevant files if it does not already reflect the version being released.
  3. Changelog: Add/update the changelog in CHANGELOG.md.
  4. Props: update CREDITS.md file with any new contributors, confirm maintainers are accurate.
  5. Readme updates: Make any other readme changes to README.md as necessary.
  6. Merge: Make a non-fast-forward merge from your release branch to develop (or merge the pull request), then do the same for develop into master (git checkout master && git merge --no-ff develop). master contains the stable development version.
  7. Push: Push your master branch to GitHub (e.g. git push origin master).
  8. Release: Create a new release, naming the tag and the release with the new version number, and targeting the master branch. Paste the changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone.
  9. Close milestone: Edit the milestone with release date (in the Due date (optional) field) and link to GitHub release (in the Description field), then close the milestone.
  10. Punt incomplete items: If any open issues or PRs which were milestoned for X.Y.Z do not make it into the release, update their milestone to X.Y.Z+1, X.Y+1.0, X+1.0.0 or Future Release.
  11. Update NPM with the latest version.