Skip to content

Commit fb6f513

Browse files
authored
Add better contributing section to README (#1)
* update contributing section to match the wiki * add better quick start and pull request sections
1 parent f90f95f commit fb6f513

File tree

1 file changed

+12
-23
lines changed

1 file changed

+12
-23
lines changed

README.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -66,33 +66,22 @@ using the complete version number.
6666

6767
## Contributing
6868

69-
Fork the repository. Then, run:
69+
If you are resubmiting an open pull request see below. If submiting a new pull request addressing an already open issue with gitflow-avh please link the relevant issue in the description. For any new issues please see below
7070

71-
```shell
72-
git clone -b master [email protected]:<username>/gitflow-cjs.git
73-
cd gitflow-cjs
74-
```
75-
76-
The `-b master` switch has to be added since the fork operation automatically
77-
clones the `develop` branch of the official gitflow repository and cloning it
78-
results in a local repository with just a `develop` branch.
79-
80-
If you do not have gitflow installed yet install it by running `make && make install`.
81-
82-
After that initialize the local gitflow repository with gitflow itself:
71+
### Quick Start for new issues
8372

84-
```shell
85-
git flow init -d
86-
git flow feature start <your feature>
87-
```
88-
89-
Then, do work and commit your changes.
73+
* Please fork and clone a local copy of [gitflow-cjs](https://github.com/CJ-Systems/gitflow-cjs).
74+
* Create a seperate issue branch based off develop.
75+
* Commit commit you fix to the local branch.
76+
* Please update your local copy with the latest devlop branch of [gitflow-cjs](https://github.com/CJ-Systems/gitflow-cjs)
77+
* Rebase develop onto your local branch.
78+
* Push your fix to your fork.
79+
* When ready to submit a pull request.
9080

91-
```shell
92-
git flow feature publish <your feature>
93-
```
81+
### How to submit a pull request
82+
When resubmitting an open pull request from [gitflow-avh](https://github.com/petervanderdoes/gitflow-avh) the base repository will need to be changed from petervanderdoes/gitflow-avh to CJ-Systems/gitflow-cjs.
9483

95-
When done, open a pull request to your feature branch.
84+
For any new PRs releated to gitflow-cjs you can use on of the keywords from [Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to automatically close the releated issue.
9685

9786
## License terms
9887

0 commit comments

Comments
 (0)