-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a contribution guide and a maintainer's guide
- Loading branch information
Showing
2 changed files
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# How to contribute to the Feature-Sliced Design CLI | ||
|
||
If you find bugs or want to propose new features, please [open an issue](https://github.com/feature-sliced/cli/issues). | ||
|
||
If you would like to make a code contribution, follow these steps: | ||
|
||
1. Fork this repository | ||
2. Make your changes | ||
3. Make sure the CLI builds correctly: `pnpm build` | ||
4. Add tests for your changes | ||
5. Make sure all tests pass: `pnpm test` and `pnpm test-integration` | ||
6. Describe your changes: `pnpm changeset` | ||
7. Make a pull request with your changes, including the changeset. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Maintainer's Guide | ||
|
||
## Publishing a new version | ||
|
||
1. Run `pnpm changeset version` and review the changes | ||
2. Commit the changes and push to `main` | ||
3. Run `pnpm changeset publish` | ||
4. Push the tag to GitHub: `git push --follow-tags` |