Add a writing documentation section and update document

This commit is contained in:
Nick Craig-Wood 2017-01-29 09:47:28 +00:00
parent 8068ef96b6
commit 20c033b484

View File

@ -43,7 +43,7 @@ When ready - run the unit tests for the code you changed
go test -v go test -v
Note that you make need to make a test remote, eg `TestSwift` for some Note that you may need to make a test remote, eg `TestSwift` for some
of the unit tests. of the unit tests.
Note the top level Makefile targets Note the top level Makefile targets
@ -59,7 +59,7 @@ packages which you can install with
Make sure you Make sure you
* Add documentation for a new feature * Add documentation for a new feature (see below for where)
* Add unit tests for a new feature * Add unit tests for a new feature
* squash commits down to one per feature * squash commits down to one per feature
* rebase to master `git rebase master` * rebase to master `git rebase master`
@ -111,16 +111,28 @@ then run in that directory
go run test_all.go go run test_all.go
## Writing Documentation ##
If you are adding a new feature then please update the documentation.
If you add a new flag, then if it is a general flag, document it in
`docs/content/docs.md` - the flags there are supposed to be in
alphabetical order. If it is a remote specific flag, then document it
in `docs/content/remote.md`.
The only documentation you need to edit are the `docs/content/*.md`
files. The MANUAL.*, rclone.1, web site etc are all auto generated
from those during the release process. See the `make doc` and `make
website` targets in the Makefile if you are interested in how. You
don't need to run these when adding a feature.
Documentation for rclone sub commands is with their code, eg
`cmd/ls/ls.go`.
## Making a release ## ## Making a release ##
There are separate instructions for making a release in the RELEASE.md There are separate instructions for making a release in the RELEASE.md
file - doing the first few steps is useful before making a file.
contribution.
* go get -u -f -v ./...
* make check
* make test
* make tag
## Updating the vendor dirctory ## ## Updating the vendor dirctory ##