feat: setup readme #2

Merged
jank merged 6 commits from setup into main 2025-04-09 21:17:18 +00:00
Showing only changes of commit 10d394907a - Show all commits

View file

@ -78,11 +78,16 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
## Getting Started
After setup, you can:
1. Create a feature branch from main
2. Make changes and commit using conventional commit format
3. Create a pull request to main
4. After approval, changes will be merged to release automatically
After completing the setup:
1. Remove the images directory and this README
2. Create feature branches from `main` for your work
3. Make changes and commit using conventional commit format
4. Create pull requests to `main` (changes should be squashed when merged, although this is not required)
5. When ready for a release, create a PR from `main` to `release`
6. The PR to `release` will automatically:
- Create a new version based on your commits
- Generate a changelog
- Merge changes back into `main`
## License