diff options
author | Jakob Borg <jakob@nym.se> | 2014-08-05 20:53:46 +0200 |
---|---|---|
committer | Jakob Borg <jakob@nym.se> | 2014-08-05 20:54:53 +0200 |
commit | 13291ad481b9ff50e6ae7d9e7152b9fb3de48681 (patch) | |
tree | fbb0750809d9179ca020a16fb8e6eebf722a54c4 /CONTRIBUTING.md | |
parent | a47ee86bee3f5ec70e78284959cc6736b44d4aed (diff) | |
download | syncthing-13291ad481b9ff50e6ae7d9e7152b9fb3de48681.tar.gz syncthing-13291ad481b9ff50e6ae7d9e7152b9fb3de48681.zip |
Tweak contribution guide
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 38 |
1 files changed, 32 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75655c380..6e255acab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,32 @@ +## Reporting Bugs + +Please file bugs in the [Github Issue +Tracker](https://github.com/syncthing/syncthing/issues). Include at +least the following: + + - What happened + + - What did you expect to happen instead of what *did* happen, if it's + not crazy obvious + + - What operating system, operating system version and version of + Syncthing you are running + + - The same for other connected nodes, where relevant + + - Screenshot if the issue concerns something visible in the GUI + + - Console log entries, where possible and relevant + +If you're not sure whether something is relevant, erring on the side of +too much information will never get you yelled at. :) + +## Contributing Code + Please do contribute! If you want to contribute but are unsure where to start, the [Contributions Needed -topic](http://discourse.syncthing.net/t/contributions-needed/49) -lists areas in need of attention. +topic](http://discourse.syncthing.net/t/49) lists areas in need of +attention. In general, any open issues are fair game! ## Licensing @@ -16,8 +41,8 @@ to add yourself as a separate commit in your first pull request. ## Building -[See the -documentation](http://discourse.syncthing.net/t/building-syncthing/44) +[See the documentation](http://discourse.syncthing.net/t/44) on how to +get started with a build environment. ## Branches @@ -44,7 +69,9 @@ Yes please! ## Style -`go fmt` + - `go fmt` + + - Unix line breaks ## Documentation @@ -53,4 +80,3 @@ Yes please! ## License MIT - |