Skip to content

Commit 3194c25

Browse files
authored
docs: documents development process (#10)
1 parent 0cb2b32 commit 3194c25

1 file changed

Lines changed: 38 additions & 2 deletions

File tree

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# http-cli
23

34
A shell script that acts like a teammate.
@@ -49,9 +50,44 @@ TIMEOUT=10
4950
This project uses [semantic-release](https://semantic-release.gitbook.io/) to automate versioning and changelog generation.
5051

5152
- Commits to `main` trigger **stable releases** (e.g. `v1.2.3`)
52-
- Commits to `develop` trigger **prereleases** (e.g. `v1.3.0-beta.1`)
5353

5454
Releases are based on [Conventional Commits](https://www.conventionalcommits.org/), so use commit messages like:
5555
- `feat: add new feature`
5656
- `fix: correct bug`
57-
- `chore: update metadata`
57+
- `chore: update metadata`
58+
59+
## Development Workflow
60+
61+
Start from `develop` your feature branch as in
62+
63+
```
64+
git checkout -b feat/something origin/develop
65+
```
66+
67+
Make your changes and any commit to the feature branch as you wish.
68+
69+
When you are ready to promote your changes to develop, from your local branch:
70+
71+
```
72+
git switch develop
73+
git pull origin develop
74+
git switch feat/something
75+
git rebase -i develop
76+
```
77+
78+
Add you fixups and edit the first commit message in a way that it represents your PR intent (`chore:`, `fix:`, `feat:` etc).
79+
80+
Now you push your feature branch and create the PR
81+
82+
```
83+
git push --force-with-lease origin HEAD
84+
```
85+
86+
Once your PR is reviewed or you consider it ok to merge anyway:
87+
88+
```
89+
git push origin <COMMIT_HASH>:develop
90+
```
91+
or use GitHub web interface and "SQUASH AND MERGE"
92+
93+

0 commit comments

Comments
 (0)