mirror of https://github.com/perkeep/perkeep.git
vendor: update contributing docs to mention the upcoming use of the dep tool
also remove vendor/README as the entire directory will be dep managed shortly. Addresses #889 Change-Id: I08aa9178ed03bfa0c2bfd80e79a10bdba2d4ef85
This commit is contained in:
parent
97752c049f
commit
5e2b7a582e
|
@ -1,3 +1,7 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
Perkeep contributors regularly use Linux and OS X, and both are
|
Perkeep contributors regularly use Linux and OS X, and both are
|
||||||
100% supported.
|
100% supported.
|
||||||
|
|
||||||
|
@ -36,6 +40,8 @@ During development, rather than use the main binaries ("camput",
|
||||||
wrapper (devcam) that automatically configure the environment to use
|
wrapper (devcam) that automatically configure the environment to use
|
||||||
the test server & test environment.
|
the test server & test environment.
|
||||||
|
|
||||||
|
## Building devcam
|
||||||
|
|
||||||
To build devcam:
|
To build devcam:
|
||||||
|
|
||||||
$ go run make.go
|
$ go run make.go
|
||||||
|
@ -49,6 +55,8 @@ can just:
|
||||||
|
|
||||||
$ go install ./dev/devcam
|
$ go install ./dev/devcam
|
||||||
|
|
||||||
|
## Running devcam
|
||||||
|
|
||||||
The subcommands of devcam start the server or run camput/camget/etc:
|
The subcommands of devcam start the server or run camput/camget/etc:
|
||||||
|
|
||||||
$ devcam server # main server
|
$ devcam server # main server
|
||||||
|
@ -69,6 +77,9 @@ Once the dev server is running,
|
||||||
|
|
||||||
- Use the UI: http://localhost:3179/ui/
|
- Use the UI: http://localhost:3179/ui/
|
||||||
|
|
||||||
|
|
||||||
|
## Testing Patches
|
||||||
|
|
||||||
Before submitting a patch, you should check that all the tests pass with:
|
Before submitting a patch, you should check that all the tests pass with:
|
||||||
|
|
||||||
$ devcam test
|
$ devcam test
|
||||||
|
@ -77,6 +88,8 @@ 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
|
change to be reviewed you should merge your commits into one before submitting
|
||||||
to gerrit for review.
|
to gerrit for review.
|
||||||
|
|
||||||
|
## Commit Messages
|
||||||
|
|
||||||
You should also try to write a meaningful commit message, which at least states
|
You should also try to write a meaningful commit message, which at least states
|
||||||
in the first sentence what part or package of perkeep this commit is affecting.
|
in the first sentence what part or package of perkeep this commit is affecting.
|
||||||
The following text should state what problem the change is addressing, and how.
|
The following text should state what problem the change is addressing, and how.
|
||||||
|
@ -87,20 +100,37 @@ https://help.github.com/articles/closing-issues-via-commit-messages/).
|
||||||
For example:
|
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
|
> 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
|
> 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.
|
> 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
|
## Vendored Code
|
||||||
in your commit message the version (e.g. git commit hash) of said third party.
|
|
||||||
|
Changes to vendored third party code must be done using the dep tool.
|
||||||
|
Information on adding, removing and updating vendor deps can be found
|
||||||
|
in the [dep documentation](https://github.com/golang/dep/blob/master/README.md).
|
||||||
|
|
||||||
|
Once you have your changes and versions specified please run the
|
||||||
|
following commands to update the vendor directory with your changes:
|
||||||
|
|
||||||
|
$ dep ensure
|
||||||
|
$ dep prune
|
||||||
|
|
||||||
|
To help track version changes please add the semantic version and the
|
||||||
|
revision in your commit message the version which you can find in the
|
||||||
|
Gopkg.lock file.
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
We follow the Go convention for commits (messages) about new Contributors.
|
We follow the Go convention for commits (messages) about new Contributors.
|
||||||
See https://golang.org/doc/contribute.html#copyright , and examples such as
|
See https://golang.org/doc/contribute.html#copyright , and examples such as
|
||||||
https://perkeep.org/gw/85bf99a7, and https://perkeep.org/gw/8f9af410.
|
https://perkeep.org/gw/85bf99a7, and https://perkeep.org/gw/8f9af410.
|
||||||
|
|
||||||
|
## git Hooks
|
||||||
|
|
||||||
You can optionally use our pre-commit hook so that your code gets gofmt'ed
|
You can optionally use our pre-commit hook so that your code gets gofmt'ed
|
||||||
before being submitted (which should be done anyway).
|
before being submitted (which should be done anyway).
|
||||||
|
|
||||||
|
|
|
@ -1,10 +0,0 @@
|
||||||
External packages which Camlistore depends on.
|
|
||||||
|
|
||||||
These are not under Camlistore copyright/license. See the respective projects
|
|
||||||
for their copyright & licensing details.
|
|
||||||
|
|
||||||
These are mirrored into Camlistore for hermetic build reasons, as well
|
|
||||||
as enabling local patching to work with an ever-changing upstream Go
|
|
||||||
project. (not all projects will follow Go tip as closely)
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue