diff options
author | Kali Kaneko (leap communications) <kali@leap.se> | 2016-10-03 20:40:03 -0400 |
---|---|---|
committer | Kali Kaneko (leap communications) <kali@leap.se> | 2016-10-03 21:48:27 -0400 |
commit | 5519d02f609a87b0ca47a8e82c116811005b6277 (patch) | |
tree | eea053d2ff8f99a80b2595119cfae829781135a1 /docs/hacking/index.rst | |
parent | 8cdbf714b905246363221089bbf8579e7c8e020c (diff) |
[docs] revamp bitmask dev docs
Diffstat (limited to 'docs/hacking/index.rst')
-rw-r--r-- | docs/hacking/index.rst | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst new file mode 100644 index 00000000..f1991afd --- /dev/null +++ b/docs/hacking/index.rst @@ -0,0 +1,77 @@ +:LastChangedDate: $LastChangedDate$ +:LastChangedRevision: $LastChangedRevision$ +:LastChangedBy: $LastChangedBy$ + +Hacking +================================= +blah blah + +Running tests +--------------------------------- + +Tox is all you need:: + + tox + +Test when changes are made to common/soledad +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If you modify soledad or leap.common packages:: + + tox -e py27-dev + +Setting up the development environment +-------------------------------------- + +Dependencies:: + + apt install ... + +There are different requirements files:: + + ... + +How to contribute +--------------------------------- + +Merge requests to https://0xacab/leap/bitmask-dev + +Coding conventions +--------------------------------- +* pep8 +* pre-commit hook (more utils in docs/hooks folder) + +Pinning +---------------------------------- +Only in the requirements files. + +Signing your commits +--------------------------------- +* For contributors with commit access + +Developing on the gui +--------------------------------- +blah blah. see some other README + +Developing on the Javascript UI +--------------------------------- +blah blah. see the main README + +Developing on the Thunderbird Extension +--------------------------------------- +blah blah + +Making a new release +-------------------- +A checklist for the release process can be found :ref:`here <release>` + +Contribution ideas +------------------ +Want to help? + +Some areas in which we always need contribution are: + +* Localization of the client (talk to elijah). +* Multiplatform gitlab runners +* Windows and OSX packaging +* Windows Firewall integration for VPN +* Migrating components to py3 (look for vshyba or kali). |