Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (27 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 3.44 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 for Agent Tools are managed right here on GitHub. Here are some ways you can help:

Reporting bugs

If you're running into an issue with the add-on, 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.

Testing

Helping to test an open source project and provide feedback on success or failure of those tests is also a helpful contribution. Submitting the results of testing as a comment on a Pull Request of a specific feature or as an Issue when testing the entire project is the best approach for providing testing results.

Workflow

The main branch is the development branch which means it contains the next version to be released. Always work on the main branch and open up PRs against main.

Release instructions

  1. Branch: Starting from main, cut a release branch named release/X.Y.Z for your changes.
  2. Version bump: Bump the version number in package.json and package-lock.json 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. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in .gitattributes.
  6. Readme updates: Make any other readme changes as necessary in README.md.
  7. Merge: Make a non-fast-forward merge from your release branch to main (or merge the pull request).
  8. Release: Create a new release, naming the tag and the release with the new version number, and targeting the main branch. Paste the changelog from CHANGELOG.md into the body of the release.
  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.