2014-01-28 19:08:45 +01:00
|
|
|
Please do contribute!
|
|
|
|
|
|
2014-03-24 14:57:14 +01:00
|
|
|
## Licensing
|
|
|
|
|
|
|
|
|
|
All contributions are made under the same MIT License as the rest of the
|
|
|
|
|
project, except documentation which is 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 CONTRIBUTORS file.
|
|
|
|
|
|
2014-01-28 19:08:45 +01:00
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
[See the wiki](https://github.com/calmh/syncthing/wiki/Building)
|
|
|
|
|
|
2014-03-24 14:55:13 +01:00
|
|
|
## 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.
|
|
|
|
|
|
2014-01-28 19:08:45 +01:00
|
|
|
## Tests
|
|
|
|
|
|
|
|
|
|
Yes please!
|
|
|
|
|
|
|
|
|
|
## Style
|
|
|
|
|
|
|
|
|
|
`go fmt`
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
[Hack it here](https://github.com/calmh/syncthing/wiki)
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
MIT
|
|
|
|
|
|
