From aaeb81521d2d146a75811a362b17d89d40ef7930 Mon Sep 17 00:00:00 2001 From: Dan Ballard Date: Fri, 29 Jun 2018 17:18:19 -0500 Subject: [PATCH] CONTRIBUTING.md --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ README.md | 4 +++- 2 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ed5b9f5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +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 diff --git a/README.md b/README.md index 72513b5..0346677 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,6 @@ Beyond individual conversations, we also seek to defend against context correlat More Information: [https://cwtch.im](https://cwtch.im) -![](https://git.openprivacy.ca/avatars/5?s=140) \ No newline at end of file +Development and Contributing information in [CONTRIBUTING.md](https://git.openprivacy.ca/cwtch.im/cwtch/src/master/CONTRIBUTING.md) + +![](https://git.openprivacy.ca/avatars/5?s=140)