From b0eeb6f6b7429ec1b35e3cd84c796bbe17545cbd Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Wed, 6 May 2015 23:18:46 +0200 Subject: [PATCH] doc: Fix spelling, link from README --- CONTRIBUTING.md | 81 +++++++++++++++++++++++++------------------------ README.md | 17 ++++------- 2 files changed, 48 insertions(+), 50 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43b7d4600..c977c6667 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,61 +1,64 @@ -This document describes the way you can contribute to the restic -project. +This document describes the way you can contribute to the restic project. -Ways to help out +Ways to Help Out ================ Thank you for your contribution! -There are several ways you can help us out. First of all code -contributions and bugfixes are most welcome. However even "minor" -details as fixing spelling errors, improving documentation or pointing -out usability issues are a great help also. +There are several ways you can help us out. First of all code contributions and +bug fixes are most welcome. However even "minor" details as fixing spelling +errors, improving documentation or pointing out usability issues are a great +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 -at the open issues listed at the [issues page][2]. This is also the -place for discussing enhancement to the restic tools. +The restic project uses the GitHub infrastructure (see the +[project page](https://github.com/restic/restic)) for all related discussions +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! -Let's get it into the project! First we would kindly ask you to fork -our project on github if you haven't done so already. +You have fixed an annoying bug or have added a new feature? Very cool! Let's +get it into the project! First we would kindly ask you to fork our project on +GitHub if you haven't done so already. -The restic project uses the *gofmt* tool for go source indentation, so -please run +The restic project uses the `gofmt` tool for go source indentation, so please +run 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 -patches, that handle one and only one issue are easier to discuss and -merge. +Then commit your changes as fine grained as possible, as smaller patches, that +handle one and only one issue are easier to discuss and merge. -Please provide the patches for each bug or feature in a separate -branch and open up a pull request for each. +Please provide the patches for each bug or feature in a separate branch and +open up a pull request for each. -Code review +Code Review =========== -The restic project encourages actively reviewing the code, as it will -store your precious data, so it's not uncommon to recieve comments on -provided patches. +The restic project encourages actively reviewing the code, as it will store +your precious data, so it's not uncommon to receive comments on provided +patches. -If you are reviewing other contributor's code please consider the -following when reviewing: +If you are reviewing other contributor's code please consider the following +when reviewing: -* Be nice. -* Please make the review comment as constructive as possible so all - paticipants will learn something from your review. +* Be nice. Please make the review comment as constructive as possible so all + participants will learn something from your review. -As a contributor you might be asked to rewrite portions of your code -to make it fit better into the upstream sources. - -[1]: https://github.com/restic/restic/ -[2]: https://github.com/restic/restic/issues +As a contributor you might be asked to rewrite portions of your code to make it +fit better into the upstream sources. diff --git a/README.md b/README.md index 58f8465a7..877e44a29 100644 --- a/README.md +++ b/README.md @@ -49,18 +49,13 @@ Install Go/Golang (at least 1.3), then run: $GOPATH/bin/restic --help -Contribute -========== +Contribute and Documentation +============================ -Contributions are welcome! Please make sure that all code submitted in -pull-requests is properly formatted with `gofmt`. Installing the script -`fmt-check` from https://github.com/edsrzf/gofmt-git-hook locally as a -pre-commit hook checks formatting before commiting, just copy this script to -`.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). +Contributions are welcome! More information can be found in +[`CONTRIBUTING.md`](CONTRIBUTING.md). A document describing the design of +restic and the data structures stored on disc is contained in +[`doc/Design.md`](doc/Design.md). Contact =======