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
This commit is contained in:
Will Norris 2016-04-27 12:10:10 -07:00
parent 7effca63b7
commit a1ec9bf60e
4 changed files with 33 additions and 32 deletions

View File

@ -40,7 +40,7 @@ To build devcam:
$ go run make.go
And devcam will be in <camroot>/bin/devcam. You'll probably want to
And devcam will be in &lt;camroot&gt;/bin/devcam. You'll probably want to
symlink it into your $PATH.
Alternatively, if your Camlistore root is checked out at
@ -62,9 +62,13 @@ $ devcam mount # cammount
Once the dev server is running,
- Upload a file:
devcam put file ~/camlistore/COPYING
- Create a permanode:
devcam put permanode
- Use the UI: http://localhost:3179/ui/
Before submitting a patch, you should check that all the tests pass with:
@ -84,28 +88,25 @@ 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:

2
README
View File

@ -11,7 +11,7 @@ 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
CONTRIBUTING how to do development and contribute
Mailing lists:

View File

@ -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.

View File

@ -36,7 +36,7 @@
<li>Usual Work Flow</li>
<ul>
<li>Create a topic branch, make some changes and commit away.</li>
<li>Read <a href="https://camlistore.googlesource.com/camlistore/+/master/HACKING">HACKING</a>. Install devcam.</li>
<li>Read <a href="https://camlistore.googlesource.com/camlistore/+/master/CONTRIBUTING.md">CONTRIBUTING</a>. Install devcam.</li>
<li>Test. (<code>devcam test</code>). </li>
<li>Squash your changes into a single change, and compose a proper commit message.</li>
<li>Send for review with: <pre>devcam review</pre></li>