From a1ec9bf60ea42f111b95e0d4ee8602e73e78b984 Mon Sep 17 00:00:00 2001 From: Will Norris Date: Wed, 27 Apr 2016 12:10:10 -0700 Subject: [PATCH] rename HACKING to CONTRIBUTING.md GitHub treats the CONTRIBUTING file special, in that it is referenced any time someone files a new issue or starts to create a pull request. Also make minor updates to file to use markdown and current hacking instructions. Change-Id: I68f0d7a69397851ee6c65671ae692cbfb2b93946 --- HACKING => CONTRIBUTING.md | 55 +++++++++++++++++++------------------- README | 4 +-- doc/server-config.md | 4 +-- website/content/code.html | 2 +- 4 files changed, 33 insertions(+), 32 deletions(-) rename HACKING => CONTRIBUTING.md (73%) diff --git a/HACKING b/CONTRIBUTING.md similarity index 73% rename from HACKING rename to CONTRIBUTING.md index 21dc267dc..eae5756cb 100644 --- a/HACKING +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ godoc.org. It's recommended you use git to fetch the source code, rather than hack from a Camlistore release's zip file: -$ git clone https://camlistore.googlesource.com/camlistore + $ git clone https://camlistore.googlesource.com/camlistore (We use github for distribution but its code review system is so poor, we don't use its Pull Request mechanism. The Gerrit git server & code @@ -29,7 +29,7 @@ to discuss the ways in which their code review tools are poor.) On Debian/Ubuntu, some deps to get started: -$ sudo apt-get install libsqlite3-dev sqlite3 pkg-config git + $ sudo apt-get install libsqlite3-dev sqlite3 pkg-config git During development, rather than use the main binaries ("camput", "camget", "camtool", "cammount", etc) directly, we instead use a @@ -38,38 +38,42 @@ the test server & test environment. To build devcam: -$ go run make.go + $ go run make.go -And devcam will be in /bin/devcam. You'll probably want to +And devcam will be in <camroot>/bin/devcam. You'll probably want to symlink it into your $PATH. Alternatively, if your Camlistore root is checked out at $GOPATH/src/camlistore.org (optional, but natural for Go users), you can just: -$ export GO15VENDOREXPERIMENT=1 # required for all Camlistore builds -$ go install ./dev/devcam + $ export GO15VENDOREXPERIMENT=1 # required for all Camlistore builds + $ go install ./dev/devcam The subcommands of devcam start the server or run camput/camget/etc: -$ devcam server # main server -$ devcam appengine # App Engine version of the server -$ devcam put # camput -$ devcam get # camget -$ devcam tool # camtool -$ devcam mount # cammount + $ devcam server # main server + $ devcam appengine # App Engine version of the server + $ devcam put # camput + $ devcam get # camget + $ devcam tool # camtool + $ devcam mount # cammount Once the dev server is running, - - Upload a file: +- Upload a file: + devcam put file ~/camlistore/COPYING - - Create a permanode: + +- Create a permanode: + devcam put permanode - - Use the UI: http://localhost:3179/ui/ + +- Use the UI: http://localhost:3179/ui/ Before submitting a patch, you should check that all the tests pass with: -$ devcam test + $ devcam test You can use your usual git workflow to commit your changes, but for each change to be reviewed you should merge your commits into one before submitting @@ -84,31 +88,28 @@ https://help.github.com/articles/closing-issues-via-commit-messages/). For example: -" -pkg/search: add "file" predicate to search by file name +> pkg/search: add "file" predicate to search by file name -File names were already indexed but there was no way to query the index for a file -by its name. The "file" predicate can now be used in search expressions (e.g. in the -search box of the web user interface) to achieve that. +> File names were already indexed but there was no way to query the index for a file +> by its name. The "file" predicate can now be used in search expressions (e.g. in the +> search box of the web user interface) to achieve that. -Fixes #10987 -" +> Fixes #10987 If your commit is adding or updating a vendored third party, you must indicate in your commit message the version (e.g. git commit hash) of said third party. We follow the Go convention for commits (messages) about new Contributors. See https://golang.org/doc/contribute.html#copyright , and examples such as -https://camlistore.googlesource.com/camlistore/+/85bf99a72974d88c2ed5d9753d97ad71766b4023 +https://camlistore.org/gw/85bf99a7 You can optionally use our pre-commit hook so that your code gets gofmt'ed before being submitted (which should be done anyway). -$ cd .git/hooks -$ ln -s ../../misc/pre-commit.githook pre-commit + $ devcam hook Finally, submit your code to gerrit with: -$ devcam review + $ devcam review Please update this file as appropriate. diff --git a/README b/README index d030b4733..7a966b0eb 100644 --- a/README +++ b/README @@ -10,8 +10,8 @@ lack of a better name. For more, see: Other useful files: - BUILDING how to compile it ("go run make.go") - HACKING how to do development and contribute + BUILDING how to compile it ("go run make.go") + CONTRIBUTING how to do development and contribute Mailing lists: diff --git a/doc/server-config.md b/doc/server-config.md index bd0c8ff3c..142f0be38 100644 --- a/doc/server-config.md +++ b/doc/server-config.md @@ -201,5 +201,5 @@ You will then have to populate that directory with all the necessary resources Alternatively, you can run `devcam appengine` once, which will create and populate the default directory (`server/appengine/source_root`). Please see the -[HACKING](https://camlistore.googlesource.com/camlistore/+/master/HACKING) doc -to build devcam. +[CONTRIBUTING](https://camlistore.googlesource.com/camlistore/+/master/CONTRIBUTING.md) +doc to build devcam. diff --git a/website/content/code.html b/website/content/code.html index 6598dace1..f509221cb 100644 --- a/website/content/code.html +++ b/website/content/code.html @@ -36,7 +36,7 @@
  • Usual Work Flow