Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test/240612 2 #24

Merged
merged 2 commits into from
Jun 12, 2024
Merged

Test/240612 2 #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5048161
fix: contributing doc
tiavina-mika Jun 12, 2024
3b194e4
fix: wf
tiavina-mika Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ on:
push:
branches:
- main
pull_request:

permissions:
contents: write
Expand Down Expand Up @@ -177,5 +176,3 @@ jobs:

${{ needs.changelog.outputs.clean_changelog }}
</details>


13 changes: 7 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ If you encounter a problem with this library or if you have a new feature you'd

Please leverage the repository's own tools to make sure the code is aligned with our standards. If you're using VSCode, it's easiest to use the recommended extensions (`.vscode/extensions.json`) to get integrated linting and autoformatting.

It's recommended to run all check commands before submitting the PR (`type:check`, `format:check`, `lint:check`, `spell:check` and `yarn lint`).
It's recommended to run all check commands before submitting the PR (`type:check`, `format:check`, `lint:check`, `spell:check`, `yarn lint` and `yarn test:coverage`).

## Development setup

1. Set up [yarn](https://yarnpkg.com/getting-started/install)
1. Set up [yarn v4](https://yarnpkg.com/getting-started/install)
2. Run `yarn`
3. Run `yarn dev` and view the demo site at the printed localhost URL

Expand All @@ -29,10 +29,11 @@ To instead test a "built" version of this package which is installed into an "ex
When a new version should be cut since some new changes have landed on the `main` branch, do the following to publish it:

1. Go to the `main` branch and pull in the latest changes.
2. Update the version in `package.json`.
3. Commit change using (commit convention)[https://nanthakumaran.medium.com/conventional-commits-simplify-your-project-history-and-automate-tasks-29007273e198]
4. Push the commit (ex: `git push origin main`)
5. The `release.yml` GitHub Actions workflow will auto-generate a tag, change log and release note
2. Commit change using (commit convention)[https://nanthakumaran.medium.com/conventional-commits-simplify-your-project-history-and-automate-tasks-29007273e198]
3. Push the commit (ex: `git push origin main`)
5. The `release.yml` GitHub Actions workflow will auto-generate a tag, change log, release note and a PR branch
6. The `automerge.yml` GitHub Actions workflow will merge and delete the PR branch
7. The `publish.yml` GitHub Actions workflow will publish the package to the npm registry

## Issue possibly encountered during installation
- [with yarn](https://stackoverflow.com/questions/67062308/getting-yn0028-the-lockfile-would-have-been-modified-by-this-install-which-is-e)
Expand Down
Loading