-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
10 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,13 +4,13 @@ This document describes how you can contribute to zswap-cli. Please read it care | |
|
||
## Issues | ||
|
||
Feel free to open issues and report bugs or ask for feature requests. | ||
Feel free to open issues, [report bugs](https://github.com/xvitaly/zswap-cli/issues/new?template=bug-report.yml), [request new features](https://github.com/xvitaly/zswap-cli/issues/new?template=feature-request.yml), or [ask questions](https://github.com/xvitaly/zswap-cli/issues/new?template=question.yml) about our project. | ||
|
||
## Pull requests | ||
|
||
1. Create your own fork by pressing **Fork** button. | ||
1. Create your own fork by clicking the **Fork** button. | ||
|
||
2. Clone your repository | ||
2. Clone your repository: | ||
```bash | ||
git clone [email protected]:YOURNAME/zswap-cli.git | ||
``` | ||
|
@@ -25,29 +25,29 @@ Feel free to open issues and report bugs or ask for feature requests. | |
git add . && git commit -sm "Full description of your changes" | ||
``` | ||
|
||
5. Add upstream as a [remote repository](https://help.github.com/articles/configuring-a-remote-for-a-fork/): | ||
5. Add the upstream as a [remote repository](https://help.github.com/articles/configuring-a-remote-for-a-fork/): | ||
```bash | ||
git remote add upstream https://github.com/xvitaly/zswap-cli.git | ||
``` | ||
|
||
6. Fetch upstream changes and [sync](https://help.github.com/articles/syncing-a-fork/) your fork's `master` branch with it: | ||
6. Fetch changes from the upstream and [sync](https://help.github.com/articles/syncing-a-fork/) your fork's `master` branch with it: | ||
```bash | ||
git fetch upstream | ||
git checkout master | ||
git merge upstream/master | ||
``` | ||
|
||
7. Rebase your feature branch to updated `master`: | ||
7. Rebase your feature branch to the updated `master`: | ||
```bash | ||
git checkout new_feature | ||
git rebase master | ||
``` | ||
|
||
8. Squash all your commits into single one and open a new pull request. | ||
8. Squash all your commits into one and open a new pull request. | ||
|
||
### Signing off your work | ||
|
||
Don't forget to sign off your work by using `git commit -s`: | ||
Don't forget to sign off your work using `git commit -s`: | ||
``` | ||
Signed-off-by: Name Surname <[email protected]> | ||
``` | ||
|
@@ -57,6 +57,6 @@ We cannot accept pull requests with commits without this signature. | |
### Some important warnings | ||
|
||
* Don't mix different line endings. | ||
* Don't upload any binary files to repository. | ||
* Don't upload any binary files to the repository. | ||
* Don't add and upload any temporary files. | ||
* Don't use any libraries incompatible with [GNU GPL v3 license](../LICENSE). | ||
* Don't use any libraries incompatible with [current license](../LICENSE). |