templates/ci-template
Template
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update getting started instructions in README
All checks were successful
Lint Pull Request / Lint PR Title (pull_request) Successful in 12s
Details

Browse source
This commit is contained in:
Jan K9f 2025-04-09 23:15:57 +02:00
parent 820242d48f
commit 10d394907a
Signed by: jank
GPG key ID: B9F475106B20F144
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -78,11 +78,16 @@ Follow the [Conventional Commits](https://www.conventionalcommits.org/) specific
## Getting Started ## Getting Started
After setup, you can: After completing the setup:
1. Create a feature branch from main 1. Remove the images directory and this README
2. Make changes and commit using conventional commit format 2. Create feature branches from `main` for your work
3. Create a pull request to main 3. Make changes and commit using conventional commit format
4. After approval, changes will be merged to release automatically 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 ## License