Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 4.4 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 4.4 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.

Workflow

The trunk branch is the main branch and contains all new code to be released in an upcoming version. A version released is just a tag of that branch.

Release instructions

  1. Branch: Starting from trunk, cut a release branch named release/X.Y.Z for your changes.
  2. Version bump: Bump the version number in cf7-repeatable-fields.php, package.json, package-lock.json, readme.txt, and any other relevant files if it does not already reflect the version being released. In cf7-repeatable-fields.php update both the plugin "Version:" property and the plugin CF7_REPEATABLE_FIELDS_VERSION constant.
  3. Changelog: Add/update the changelog in CHANGELOG.md and readme.txt, ensuring to link the [X.Y.Z] release reference in the footer of CHANGELOG.md (e.g., https://github.com/felipeelia/cf7-repeatable-fields/compare/X.Y.Z-1...X.Y.Z). Update the Unreleased link to https://github.com/felipeelia/cf7-repeatable-fields/compare/X.Y.Z...trunk
  4. Props: Update CREDITS.md file with any new contributors, confirm maintainers are accurate.
  5. Readme updates: Make any other readme changes as necessary. README.md is geared toward GitHub and readme.txt contains WordPress.org-specific content. The two are slightly different.
  6. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in .distignore.
  7. POT file: Run wp i18n make-pot . languages/cf7-repeatable-fields.pot and commit the file. In case of errors, try to disable Xdebug (see this comment.)
  8. Release date: Double check the release date in both changelog files.
  9. Merge: Merge the release branch/PR into trunk.
  10. Test: Run git pull origin trunk and test for functionality locally.
  11. Release: Create a new release, naming the release and the new tag with the new version number (X.Y.Z). Paste the release changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone.
  12. SVN: Wait for the GitHub Action to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
  13. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/cf7-repeatable-fields/. This may take a few minutes.
  14. 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.
  15. 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.