git
, node
, yarn
.revert:
, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>.
, where the hash is the SHA of the commit being reverted. A commit with this format is automatically created by the git revert
command.BREAKING CHANGE:
with a space or two newlines. The rest of the commit message is then used for this.@param {type} name description
- describes a parameter of a function@returns {type} description
- describes what a function returns@property
- describes a property of an object@description
- used to provide a description of a component in markdown@example
- specifies an example.@public
- Only methods with @public tag will be included in the docstype
in @param
and @returns
must be wrapped in {}
curly braces, e.g. {Object|Array}
. Parameters can be made optional by either appending a =
to the type, e.g. {Object=}
, or by putting the [name]
in square brackets. Default values are only possible with the second syntax by appending =<value>
to the parameter name, e.g. @param {boolean} [ownPropsOnly=false]
.npm version major | minor | patch
to update version accordingly. 2. Update CHANGELOG.md with the latest commit changes. Print commits with git log --pretty=oneline --abbrev-commit
3. Create a new PR for review. 4. Once the PR is reviewed and merged, pull the latest changes locally. 5. Run gh-release
: this command will create a new Github Release with the new updated CHANGELOG.md section. 6. Once the new Github Release is created, Github will automatically trgger a new Github Action flow that will automatically build and publish the new package version to NPM registry.