Skip to content

Commit

Permalink
Add a contribution guide and a maintainer's guide
Browse files Browse the repository at this point in the history
  • Loading branch information
illright committed Jan 14, 2024
1 parent fdc3b89 commit aa72d28
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
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.
8 changes: 8 additions & 0 deletions MAINTAINER_GUIDE.md
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`

0 comments on commit aa72d28

Please sign in to comment.