cwtch/CONTRIBUTING.md

37 lines
1.0 KiB
Markdown
Raw Permalink Normal View History

2018-06-29 22:18:19 +00:00
Sign up to the [Open Privacy Gogs instance](https://git.openprivacy.ca/)
Get the code
clone gogs@git.openprivacy.ca:cwtch.im/cwtch.git
Make a development branch to do your work
git checkout -b work-branch-name
If you are using Goland as an IDE, now would be a good time to enable automatic gofmt on save of files with the File Watches plugin [https://stackoverflow.com/questions/33774950/execute-gofmt-on-file-save-in-intellij](StackOverflow)
When you are done, rebase squash any multiple commits you have into one
git rebase -i master
Test the code and check it has not quality issues
./testing/tests.sh
./testing/quality.sh
Ideally run the ingegration tests (~5 minutes)
cd testing
go test
push your branch (-f for *force* in the case you've rebased and squashed)
git push origin work-branch-name -f
create a [pull request](https://git.openprivacy.ca/cwtch.im/cwtch/pulls)
If you have fixes, you can ammend them to the current commit rather than a new one with
git commit --ammend
git push -f