aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJakob Borg <jakob@nym.se>2015-06-10 00:02:39 +0200
committerJakob Borg <jakob@nym.se>2015-06-10 00:02:39 +0200
commit9a11f81fd357486883bd512f3e370382578111c3 (patch)
tree3363d54f1c0e6dca28888ee23830c1a2443aafa4 /CONTRIBUTING.md
parentcba2e972fd4e0e88955fb240d65b9fa9132911c3 (diff)
downloadsyncthing-9a11f81fd357486883bd512f3e370382578111c3.tar.gz
syncthing-9a11f81fd357486883bd512f3e370382578111c3.zip
Point to contribution guidelines and docs
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md101
1 files changed, 6 insertions, 95 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c1b26980d..91f5f4e50 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,64 +32,14 @@ latest info on Transifex.
## Contributing Code
Every contribution is welcome. If you want to contribute but are unsure
-where to start, any open issues are fair game! Be prepared for a
-[certain amount of review](http://docs.syncthing.net/dev/intro.html#why-are-you-being-so-hard-on-my-pull-request);
-it's all in the name of quality. :) Following the points below will make this
-a smoother process.
+where to start, any open issues are fair game! See the [Contribution
+Guidelines] for the full story on committing code.
-Individuals making significant and valuable contributions are given
-commit-access to the project. If you make a significant contribution and
-are not considered for commit-access, please contact any of the
-Syncthing core team members.
+## Contributing Documentation
-All nontrivial contributions should go through the pull request
-mechanism for internal review. Determining what is "nontrivial" is left
-at the discretion of the contributor.
-
-### Authorship
-
-All code authors are listed in the AUTHORS file. Commits must be made
-with the same name and email as listed in the AUTHORS file. To
-accomplish this, ensure that your git configuration is set correctly
-prior to making your first commit;
-
- $ git config --global user.name "Jane Doe"
- $ git config --global user.email janedoe@example.com
-
-You must be reachable on the given email address. If you do not wish to
-use your real name for whatever reason, using a nickname or pseudonym is
-perfectly acceptable.
-
-### Core Team
-
-The Syncthing core team currently consists of the following members;
-
- - Jakob Borg (@calmh)
- - Audrius Butkevicius (@AudriusButkevicius)
-
-## Coding Style
-
-- Follow the conventions laid out in [Effective Go](https://golang.org/doc/effective_go.html)
- as much as makes sense.
-
-- All text files use Unix line endings.
-
-- Each commit should be `go fmt` clean.
-
-- The commit message subject should be a single short sentence
- describing the change, starting with a capital letter.
-
-- Commits that resolve an existing issue must include the issue number
- as `(fixes #123)` at the end of the commit message subject.
-
-- Imports are grouped per `goimports` standard; that is, standard
- library first, then third party libraries after a blank line.
-
-- A contribution solving a single issue or introducing a single new
- feature should probably be a single commit based on the current
- `master` branch. You may be asked to "rebase" or "squash" your pull
- request to make sure this is the case, especially if there have been
- amendments during review.
+Updates to the [documentation site](http://docs.syncthing.net/) can be
+made as pull requests on the [documentation
+repository](https://github.com/syncthing/docs).
## Licensing
@@ -99,42 +49,3 @@ strings which are licensed under the Creative Commons Attribution 4.0
International License. You retain the copyright to code you have
written.
-When accepting your first contribution, the maintainer of the project
-will ensure that you are added to the AUTHORS file, the NICKS file and
-the list of authors in the about box.
-
-## Building
-
-[See the documentation](http://docs.syncthing.net/dev/building.html)
-on how to get started with a build environment.
-
-## Branches
-
- - `master` is the main branch containing good code that will end up in
- the next release. You should base your work on it. It won't ever be
- rebased or force-pushed to.
-
- - `vx.y` branches exist to make patch releases on otherwise obsolete
- minor releases. Should only contain fixes cherry picked from master.
- Don't base any work on them.
-
- - Other branches are probably topic branches and may be subject to
- rebasing. Don't base any work on them unless you specifically know
- otherwise.
-
-## Tags
-
-All releases are tagged semver style as `vx.y.z`. Release tags are
-signed by GPG key BCE524C7.
-
-## Tests
-
-Yes please!
-
-## Documentation
-
-[Over here!](http://docs.syncthing.net/)
-
-## License
-
-MPLv2