Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 7.38 KB

CONTRIBUTING.md

File metadata and controls

76 lines (47 loc) · 7.38 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 Insecure Content Warning are managed right here on GitHub. Here are some ways you can help:

Reporting bugs

If you're running into an issue with the plugin, 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. As project owners, 10up sets the direction and roadmap and may not prioritize or decide to implement if outside of the main goals of the plugin.

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. You can find details on the Critical Flows and Test Cases in this project's GitHub Wiki as well as details on our overall approach to Critical Flows and Test Cases in our Open Source Best Practices. Submitting the results of testing via our Critical Flows 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.

Maintenance process

Triage

Issues and WordPress.org forum posts should be reviewed weekly and triaged as necessary. Not all tasks have to be done at once or by the same person. Triage tasks include:

  • Responding to new WordPress.org forum posts and GitHub issues/PRs with an acknolwedgment and following up on existing open/unresolved items that have had movement in the previous week.
  • Marking forum posts as resolved when corresponding issues are fixed or as not a support issue if not relevant.
  • Creating GitHub issues for WordPress.org forum posts as necessary or linking to them from existing related issues.
  • Applying labels and milestones to GitHub issues.

Issue labels

All issues should be labeled as bugs (type:bug), enhancements/feature requests (type:enhancement), or questions/support (type:question). Each issue should only be of one "type".

Bugs and enhancements that are closed without a related change should be labeled as declined, duplicate, or invalid. Invalid issues would be where a problem is not reproducible or opened in the wrong repo and should be relatively uncommon. These labels are all prefixed with closed:.

There are two other labels that are GitHub defaults with more global meaning we've kept: good first issue and help wanted.

Review against WordPress updates

During weekly triage, the tested up to version should be compared against the latest versions of WordPress and Gutenberg. If there's a newer version of either, the plugin should be re-tested using any automated tests as well as any manual tests indicated below, and the tested up to version bumped and committed to both GitHub and the WordPress.org repository.

Release cycle

New releases are targeted based on number and severity of changes along with human availability. When a release is targeted, a due date will be assigned to the appropriate milestone.

Testing

TBD

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 insecure-content-warning.php, readme.txt, package.json and package-lock.json if it does not already reflect the version being released. Update both the plugin "Version:" property and the plugin INSECURE_CONTENT_VERSION constant in insecure-content-warning.php.
  3. Changelog: Add/update the changelog in CHANGELOG.md and readme.txt.
  4. Props: update CREDITS.md 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 .distignore.
  6. 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.
  7. 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 trunk, ensuring you pull the most recent changes into develop first (git checkout develop && git pull origin develop && git checkout trunk && git merge --no-ff develop). trunk contains the stable development version.
  8. Push: Push your trunk branch to GitHub (e.g. git push origin trunk).
  9. Compare trunk to develop to ensure no additional changes were missed.
  10. Test the pre-release ZIP locally by downloading it from the Build release zip action artifact and installing it locally. Ensure this zip has all the files we expect, that it installs and activates correctly and that all basic functionality is working.
  11. Release: Create a new release, naming the tag and the release with the new version number, and targeting the trunk branch. Paste the 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 WordPress.org. This may take a few minutes.
  14. Close the 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+1.0.0, X.Y+1.0, X.Y.Z+1, or Future Release.