Skip to content

Commit 3e022ba

Browse files
authored
Merge pull request #16 from crowdsecurity/feature/update-git-workflow
use github flow
2 parents 02d7e1f + 769aef3 commit 3e022ba

File tree

1 file changed

+10
-37
lines changed

1 file changed

+10
-37
lines changed

docs/contribute.md

Lines changed: 10 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Here is the development environment for this library:
1111

1212
- We use TDD to code the library, with PHP Unit
1313
- CI via Github actions: run all tests over each PHP versions
14-
- Git workflow: Git Flow [as it's a software](https://github.com/nvie/gitflow#creating-featurereleasehotfixsupport-branches)
14+
- Git workflow: [Github Flow](https://guides.github.com/introduction/flow/)
1515
- PHP Source fully documented
1616
- Versioning system: Semver
1717
- Code coverage (not now)
@@ -55,48 +55,21 @@ docker-compose run --rm app vendor/bin/phpdoc-md
5555

5656
## The git workflow we use
5757

58-
More info here: https://danielkummer.github.io/git-flow-cheatsheet/
58+
We use the git workflow [Github Flow](https://guides.github.com/introduction/flow/).
5959

60-
To start a new feature:
60+
### Cheatsheet
6161

62-
```bash
63-
git flow feature start <name>
64-
```
65-
66-
To push the feature to Github:
67-
68-
```bash
69-
git flow feature publish <name>
70-
```
71-
72-
To pull the feature from Github:
62+
#### New feature
7363

7464
```bash
75-
git flow feature pull <name>
65+
git checkout -b feature/<the-feature>
66+
git commit # as mush as necessary
67+
git push origin feature/<the-feature>
68+
gh pr create --fill
7669
```
7770

78-
Important: As we use pull requests, we just don't use `git flow feature finish <name>` and we just remove the local branch when the PR is merged. More info [here](https://stackoverflow.com/questions/55706856/proper-way-to-use-gitflow-with-pull-requests).
79-
80-
To create a release:
81-
82-
```bash
83-
git flow release start vx.x.x
84-
git flow release publish vx.x.x
85-
git flow release finish vx.x.x
86-
```
87-
88-
Then create a new release manually in Github or use `gh release create (...)` if you use **gh** cli.
89-
90-
And more...
71+
#### New release
9172

9273
```bash
93-
usage: git flow feature [list] [-v]
94-
git flow feature start [-F] <name> [<base>]
95-
git flow feature finish [-rFk] <name|nameprefix>
96-
git flow feature publish <name>
97-
git flow feature track <name>
98-
git flow feature diff [<name|nameprefix>]
99-
git flow feature rebase [-i] [<name|nameprefix>]
100-
git flow feature checkout [<name|nameprefix>]
101-
git flow feature pull <remote> [<name>]
74+
gh release create vx.x.x
10275
```

0 commit comments

Comments
 (0)