mirror of
https://github.com/kanidm/kanidm.git
synced 2025-02-23 04:27:02 +01:00
Add some git instructions
This commit is contained in:
parent
81d61df9f7
commit
3c964c51e7
60
README.md
60
README.md
|
@ -46,6 +46,66 @@ See CODE_OF_CONDUCT.md
|
|||
|
||||
## Get involved
|
||||
|
||||
To get started, you'll need to fork or branch, and we'll merge based on PR's.
|
||||
|
||||
If you are a contributor to the project, simply clone:
|
||||
|
||||
```
|
||||
git clone git@github.com:Firstyear/kanidm.git
|
||||
```
|
||||
|
||||
If you are forking, then Fork in github and clone with:
|
||||
|
||||
```
|
||||
git clone https://github.com/Firstyear/kanidm.git
|
||||
cd kanidm
|
||||
git remote add myfork git@github.com:<YOUR USERNAME>/kanidm.git
|
||||
```
|
||||
|
||||
Select and issue (and always feel free to reach out to us for advice!), and create a branch to
|
||||
start working:
|
||||
|
||||
```
|
||||
git branch <feature-branch-name>
|
||||
git checkout <feature-branche-name>
|
||||
```
|
||||
|
||||
When you are ready for review (even if the feature isn't complete and you just want some advice)
|
||||
|
||||
```
|
||||
git commit -m 'Commit message' change_file.rs ...
|
||||
git push <myfork/origin> <feature-branch-name>
|
||||
```
|
||||
|
||||
If you get advice or make changes, just keep commiting to the branch, and pushing to your branch.
|
||||
When we are happy with the code, we'll merge in github, meaning you can now cleanup your branch.
|
||||
|
||||
```
|
||||
git checkout master
|
||||
git pull
|
||||
git branch -D <feature-branch-name>
|
||||
```
|
||||
|
||||
Rebasing:
|
||||
|
||||
If you are asked to rebase your change, follow these steps:
|
||||
|
||||
```
|
||||
git checkout master
|
||||
git pull
|
||||
git checkout <feature-branche-name>
|
||||
git rebase master
|
||||
```
|
||||
|
||||
Then be sure to fix any merge issues or other comments as they arise. If you have issues, you can
|
||||
always stop and reset with:
|
||||
|
||||
```
|
||||
git rebase --abort
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Designs
|
||||
|
||||
See the designs folder
|
||||
|
|
Loading…
Reference in a new issue