From aa72d280e84115234edd99db2e20cc7487e4fcdf Mon Sep 17 00:00:00 2001 From: Lev Chelyadinov Date: Sun, 14 Jan 2024 23:27:54 +0100 Subject: [PATCH] Add a contribution guide and a maintainer's guide --- CONTRIBUTING.md | 13 +++++++++++++ MAINTAINER_GUIDE.md | 8 ++++++++ 2 files changed, 21 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 MAINTAINER_GUIDE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c893ba6 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/MAINTAINER_GUIDE.md b/MAINTAINER_GUIDE.md new file mode 100644 index 0000000..7f0ccec --- /dev/null +++ b/MAINTAINER_GUIDE.md @@ -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`