Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mheap committed Nov 24, 2023
1 parent 2e92df2 commit 247c27a
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## Adding Features

This repository uses [changesets](https://github.com/changesets/changesets) to manage package versioning. When adding a new feature, run `npx changeset add` from the root directory. This will prompt you for a short description of the change and let you interactively select which packages you've edited, and if there are major, minor or patch level changes.

Commit the `.changesets` folder alongside your code when raising a pull request. The content of your changeset should be used as the body for your PR.

## Running Tests

From the root directory:
Expand All @@ -6,3 +12,15 @@ From the root directory:
pnpm build
pnpm test
```

## Releasing

Releases are a two step process:

1. Bump versions by aggregating unprocessed changesets using `npx changeset version`
2. Commit all changes
3. Publish packages using `npx changeset publish`

GitHub Actions can perform both of these tasks. Any merge to `main` with unprocessed changesets results in a pull request with bumped versions. Any merge to main _without_ unprocessed changesets triggers `changeset publish`.

@mheap tends to run `changeset version` locally, commit the bumped versions with a commit message in the format `release(package): x.y.z` and push to main to trigger a release.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Trello CLI

This is a monorepo for everything related to Trello CLI. You're probably looking for the [trello CLI](https://github.com/mheap/trello-cli/tree/main/packages/trello-cli) README.
This is a monorepo for everything related to Trello CLI. You're probably looking for the [trello CLI](https://github.com/mheap/trello-cli/tree/main/packages/trello-cli) README.

For information on contributing, see [CONTRIBUTING.md](https://github.com/mheap/trello-cli/blob/main/CONTRIBUTING.md)

0 comments on commit 247c27a

Please sign in to comment.