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.
Contributing isn't just writing code - it's anything that improves the project. All contributions for Embed Block for Figma are managed right here on GitHub. Here are some ways you can help:
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.
New features and enhancements are also managed via issues.
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.
The develop
branch is the development branch which means it contains the next version to be released. trunk
contains the latest released version as reflected in the WordPress.org plugin repository. Always work on the develop
branch and open up PRs against develop
.
- Branch: Starting from
develop
, cut a release branch namedrelease/X.Y.Z
for your changes. - Version bump: Bump the version number in
embed-block-figma.php
,package-lock.json
,package.json
, andreadme.txt
if it does not already reflect the version being released. Inembed-block-figma.php
update both the plugin "Version:" property and the pluginFIGMA_BLOCK_VERSION
constant. - Changelog: Add/update the changelog in
CHANGELOG.md
andreadme.txt
. - Props: update
CREDITS.md
file with any new contributors, confirm maintainers are accurate. - New files: Check to be sure any new files/paths that are unnecessary in the production version are included in
.gitattributes
. - Readme updates: Make any other readme changes as necessary.
README.md
is geared toward GitHub andreadme.txt
contains WordPress.org-specific content. The two are slightly different. - Merge: Make a non-fast-forward merge from your release branch to
develop
(or merge the pull request), then do the same fordevelop
intotrunk
, ensuring you pull the most recent changes intodevelop
first (git checkout develop && git pull origin develop && git checkout trunk && git merge --no-ff develop
).trunk
contains the stable development version. - Push: Push your trunk branch to GitHub (e.g.
git push origin trunk
). - Compare
trunk
todevelop
to ensure no additional changes were missed. - 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.
- Release: Create a new release, naming the tag and the release with the new version number, and targeting the
trunk
branch. Paste the changelog fromCHANGELOG.md
into the body of the release and include a link to the closed issues on the milestone. - 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.
- Check WordPress.org: Ensure that the changes are live on WordPress.org. This may take a few minutes.
- Close milestone: Edit the milestone with release date (in the
Due date (optional)
field) and link to GitHub release (in theDescription field
), then close the milestone. - 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 toX.Y.Z+1
,X.Y+1.0
,X+1.0.0
orFuture Release
.