summaryrefslogtreecommitdiff
path: root/docs/hacking/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/hacking/index.rst')
-rw-r--r--docs/hacking/index.rst77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst
new file mode 100644
index 0000000..f1991af
--- /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).