Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 6.14 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 6.14 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 Restricted Site Access 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.

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.

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 trunk 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, restricted_site_access.php, andreadme.txt if it does not already reflect the version being released. In restricted_site_access.php update both the plugin "Version:" property and the pluginRSA_VERSION constant.
  3. Changelog: Add/update the changelog in readme.txt and 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 and .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. Either perform a regression testing utilizing the available Critical Flows and Test Cases or if end-to-end tests cover a significant portion of those Critical Flows then run e2e tests. Only proceed if everything tests successfully.
  12. 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 (e.g. https://github.com/10up/restricted-site-access/milestone/2?closed=1). The release should now appear under releases.
  13. 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.
  14. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/restricted-site-access/. This may take a few minutes.
  15. Close milestone: Edit the X.Y.Z milestone with release date (in the Due date (optional) field) and link to GitHub release (in the Description field), then close X.Y.Z milestone.
  16. 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.