Add some guidance on contributing and bump version #84
Conversation
GeraldRequired Reviewers
Don't want to be involved in this pull request? Comment |
CODE_OF_CONDUCT.md
Outdated
There was a problem hiding this comment.
note: Copied from Wonder Stuff
There was a problem hiding this comment.
note: Copied from Wonder Stuff and updated for Gerald specifics.
|
|
||
| ### Publishing | ||
|
|
||
| Once changes are landed to `main` and the `dist` directory is up-to-date, you should bump the version in the `package.json` (either major or minor version), commit and land that change to `main` via a PR, and then create a tag in the format `vX.Y` where `X.Y` is the version number. Then push the tag to GitHub with `git push --tags`. |
There was a problem hiding this comment.
note: This was the main reason I added this. I wanted to document the process for future me (and others).
| @@ -1,5 +1,5 @@ | |||
| { | |||
| "version": "3.4.0", | |||
| "version": "4.0.0", | |||
There was a problem hiding this comment.
note: Bump to v4 ready for tagging, to test out the updated autofix action. Major bump due to the Node 20 stuff.
| @@ -42,6 +42,6 @@ jobs: | |||
| run: yarn build | |||
| if: steps.paths_src_.outputs.changed == 'true' | |||
|
|
|||
| - uses: Khan/autofix-commit-action@master | |||
| - uses: Khan/autofix-commit-action@main | |||
There was a problem hiding this comment.
note: Caught this because I was still getting Node16 deprecation warnings after fixing that in the Khan/autofix-commit-action repo.
Includes src file change to ensure we test the build case
…o detect changed files
Summary:
This PR adds a
CODE_OF_CONDUCT.mdandCONTRIBUTING.mdfile to the repository, which were copied from Wonder Stuff before tweakingCONTRIBUTING.mdto cover Gerald's specifics.This also bumps the
package.jsonto version4.0.0, ready for a new tag once this lands.This PR also should test the updated autofix action, which hopefully means no more Node16 deprecation warnings.
Issue: FEI-5545
Test plan:
I did a
yarn buildlocally to check thedistchanges. Pushing this PR up should trigger our workflow runs to verify they are correct.