Skip to content

Commit

Permalink
docs: documentation and contribution guidelines updated
Browse files Browse the repository at this point in the history
  • Loading branch information
arunvishnun committed Jan 5, 2023
1 parent 27ba25a commit fac1047
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,17 +108,6 @@ And open your browser to `http://localhost:4000` to view the docs locally.

The versioning of modules in the this repo are done using `rush change`. Read more about [best practices]

It's important that commits are isolated for the package they affected only and contains the version tags `[major]`, `[minor]`, or `[patch]`. `[patch]` is the default if tag is not found in commit message.

To release, follow these steps:

1. Use `xrun update-changelog` to detect packages that changed and their version bumps.
2. Verify and check the file `CHANGELOG.md`, add a summary of key changes under the date.
3. Amend the commit for `CHANGELOG.md` with summary changes.
4. Run `npx fynpo prepare --no-tag` to prepare packages for release.
5. Run `git tag -a rel-v<#>-<date>` where `<#>` is the major archetype version, and `<date>` as `YYYYMMDD`. (ie: `rel-v9-20210301`)
6. Publish the packages that has version bumps.
7. Push the release commits.

[prettier]: https://www.npmjs.com/package/prettier

Expand Down

0 comments on commit fac1047

Please sign in to comment.