syncthing/CONTRIBUTING.md

42 lines
858 B
Markdown
Raw Normal View History

2014-01-28 19:08:45 +01:00
Please do contribute!
## 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