octoleo
/
restic
mirror of https://github.com/octoleo/restic.git
2
2
Fork 0
Code Issues Releases Wiki Activity

doc: Fix spelling, link from README

This commit is contained in:
Alexander Neumann 2015-05-06 23:18:46 +02:00
parent f0c6e7010e
commit b0eeb6f6b7
2 changed files with 48 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
CONTRIBUTING.md
View File

@ -1,61 +1,64 @@
This document describes the way you can contribute to the restic This document describes the way you can contribute to the restic project.
project.
Ways to help out Ways to Help Out
================ ================
Thank you for your contribution! Thank you for your contribution!
There are several ways you can help us out. First of all code There are several ways you can help us out. First of all code contributions and
contributions and bugfixes are most welcome. However even "minor" bug fixes are most welcome. However even "minor" details as fixing spelling
details as fixing spelling errors, improving documentation or pointing errors, improving documentation or pointing out usability issues are a great
out usability issues are a great help also. help also.
The restic project uses the github infrastructure ([project page][1])
for all related discussions as well as the '#restic' channel on
irc.freenode.net.
If you want to find an area that currently needs improving have a look The restic project uses the GitHub infrastructure (see the
at the open issues listed at the [issues page][2]. This is also the [project page](https://github.com/restic/restic)) for all related discussions
place for discussing enhancement to the restic tools. as well as the `#restic` channel on `irc.freenode.net`.
Providing patches If you want to find an area that currently needs improving have a look at the
open issues listed at the
[issues page](https://github.com/restic/restic/issues). This is also the place
for discussing enhancement to the restic tools.
If you are unsure what to do, please have a look at the issues, especially
those tagged
[minor complexity](https://github.com/restic/restic/labels/minor%20complexity).
Providing Patches
================= =================
You have fixed an annoying bug or have added a new feature? Very cool! You have fixed an annoying bug or have added a new feature? Very cool! Let's
Let's get it into the project! First we would kindly ask you to fork get it into the project! First we would kindly ask you to fork our project on
our project on github if you haven't done so already. GitHub if you haven't done so already.
The restic project uses the *gofmt* tool for go source indentation, so The restic project uses the `gofmt` tool for go source indentation, so please
please run run
gofmt -w **/*.go gofmt -w **/*.go
in the project root directory before commiting. in the project root directory before committing. Installing the script
`fmt-check` from https://github.com/edsrzf/gofmt-git-hook locally as a
pre-commit hook checks formatting before committing automatically, just copy
this script to `.git/hooks/pre-commit`.
Then commit your changes as fine grained as possible, as smaller Then commit your changes as fine grained as possible, as smaller patches, that
patches, that handle one and only one issue are easier to discuss and handle one and only one issue are easier to discuss and merge.
merge.
Please provide the patches for each bug or feature in a separate Please provide the patches for each bug or feature in a separate branch and
branch and open up a pull request for each. open up a pull request for each.
Code review Code Review
=========== ===========
The restic project encourages actively reviewing the code, as it will The restic project encourages actively reviewing the code, as it will store
store your precious data, so it's not uncommon to recieve comments on your precious data, so it's not uncommon to receive comments on provided
provided patches. patches.
If you are reviewing other contributor's code please consider the If you are reviewing other contributor's code please consider the following
following when reviewing: when reviewing:
* Be nice. * Be nice. Please make the review comment as constructive as possible so all
* Please make the review comment as constructive as possible so all participants will learn something from your review.
paticipants will learn something from your review.
As a contributor you might be asked to rewrite portions of your code As a contributor you might be asked to rewrite portions of your code to make it
to make it fit better into the upstream sources. fit better into the upstream sources.
[1]: https://github.com/restic/restic/
[2]: https://github.com/restic/restic/issues

17
README.md
View File

@ -49,18 +49,13 @@ Install Go/Golang (at least 1.3), then run:
$GOPATH/bin/restic --help $GOPATH/bin/restic --help
Contribute Contribute and Documentation
========== ============================
Contributions are welcome! Please make sure that all code submitted in Contributions are welcome! More information can be found in
pull-requests is properly formatted with `gofmt`. Installing the script [`CONTRIBUTING.md`](CONTRIBUTING.md). A document describing the design of
`fmt-check` from https://github.com/edsrzf/gofmt-git-hook locally as a restic and the data structures stored on disc is contained in
pre-commit hook checks formatting before commiting, just copy this script to [`doc/Design.md`](doc/Design.md).
`.git/hooks/pre-commit`.
If you are unsure what to do, please have a look at the github issues,
especially those tagged
[minor complexity](https://github.com/restic/restic/labels/minor%20complexity).
Contact Contact
======= =======