Official cwtch.im peer and server implementations. https://cwtch.im
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

CONTRIBUTING.md 1.7KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. # Contributing
  2. ## Getting Started
  3. Sign up to the [Open Privacy Gogs instance](https://git.openprivacy.ca/)
  4. Get the code
  5. clone gogs@git.openprivacy.ca:cwtch.im/cwtch.git
  6. Make a development branch to do your work
  7. git checkout -b work-branch-name
  8. 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)
  9. ## Pull Requests
  10. When you are done, rebase squash any multiple commits you have into one
  11. git rebase -i master
  12. Test the code and check it has not quality issues
  13. ./testing/tests.sh
  14. ./testing/quality.sh
  15. Ideally run the integration tests (~5 minutes)
  16. cd testing
  17. go test
  18. push your branch (-f for *force* in the case you've rebased and squashed)
  19. git push origin work-branch-name -f
  20. create a [pull request](https://git.openprivacy.ca/cwtch.im/cwtch/pulls)
  21. If you have fixes, you can amend them to the current commit rather than a new one with
  22. git commit --amend
  23. git push -f
  24. ## Review Board
  25. For very large and complicated Pull Requests we have created a Review Board instance to facilitate more in depth review and discussion at https://review.openprivacy.ca
  26. First acquire the client, RBTools, on Ubuntu:
  27. apt install rbtools
  28. Then hookup your git repo to review board with:
  29. rbt setup-repo
  30. Using the repo `cwtch`
  31. Finally you will be able to create commits with
  32. rbt post --parent master
  33. It possibly will need the arguments `--tracking-branch=cwtch/master --branch=YOUR-BRANCH -d` (-d for debug if you are having trouble)