blob: 4826f4838c24394854320c884f0b649f806b6d97 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
: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 are developing against a non-published branch of ``leap.common`` or
``leap.soledad``, run instead::
tox -e py27-dev
This expects ``leap_common`` and ``soledad`` repos to be checked out in the
parent folder.
Setting up the development environment
--------------------------------------
Dependencies::
sudo apt install build-essential python-virtualenv libsqlcipher-dev \
libssl-dev libffi-dev
There are different requirements files::
...
How to contribute
---------------------------------
Merge requests to https://0xacab/leap/bitmask-dev
Coding conventions
---------------------------------
* pep8
* Git messages should be informative.
* There is a pre-commit hook ready to be used in the ``docs/hooks`` folder,
alongside some other hooks to do autopep8 on each commit.
.. include:: ../hooks/leap-commit-template.README
:literal:
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).
|
