summaryrefslogtreecommitdiff
path: root/doc/en/dev/contributing.txt
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-08 18:52:35 +0200
committermathieui <mathieui@mathieui.net>2013-04-08 18:52:35 +0200
commitbd8d38d711e15d42ac8e797723af5242e4c3f4fb (patch)
treed3ea6da641be1c7e67a3123071cb816933436502 /doc/en/dev/contributing.txt
parente5f219d43edbb4b05c8890f81f2f93b90e215a10 (diff)
downloadpoezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.tar.gz
poezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.tar.bz2
poezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.tar.xz
poezio-bd8d38d711e15d42ac8e797723af5242e4c3f4fb.zip
Beginning of the migration to reST documentation
Diffstat (limited to 'doc/en/dev/contributing.txt')
-rw-r--r--doc/en/dev/contributing.txt71
1 files changed, 0 insertions, 71 deletions
diff --git a/doc/en/dev/contributing.txt b/doc/en/dev/contributing.txt
deleted file mode 100644
index 6dbda93e..00000000
--- a/doc/en/dev/contributing.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-Contributing
-============
-
-Conventions
------------
-
-We don’t have a strict set of conventions, but you should respect PEP8 mostly
-(e.g. 4 spaces, class names in CamelCase and methods lowercased with
-underscores) except if it means less-readable code (80 chars is often a hassle,
-and if you look inside poezio you’ll see lots of long lines, mostly because of
-strings).
-
-
-As explained in the link:./overview.html[overview], “global” code goes in
-_core.py_, tab-related code goes in _tabs.py_, and ui-related code goes in
-_windows.py_. There are other modules (e.g. xhtml.py) but they do not matter
-for the application as a whole.
-
-Commit guidelines
------------------
-
-Commits _should_ have a meaninful title (first line), and _may_ have a detailed
-description below. There are of course exceptions (for example, a single-line
-commit that takes care of a typo right behind a big commit does not need to
-say “fix a typo ("azre" → "are") in toto.py line 45454", since the metainfos
-already take care of that.), but if you do not have commit access on the
-poezio trunk, you can still reset and commit again.
-
-
-Try to do atomic commits: since git is a DVCS, it doesn’t hurt to git add -p
-and split the commit into several meaningful small commits ; on the contrary,
-it helps to track the changes on different levels.
-
-
-If you have a conflict, solve it with rebase and not merge if the fast-forwards
-do not resolve it automatically in your case. This helps to avoid creating
-useless merges (and polluting the commit history) when none is needed.
-
-.Basic case
-==========================
-
- git fetch origin
- git rebase origin/master
- git push origin master
-
-==========================
-
-If your commit is related to an issue on
-link:https://dev.louiz.org/project/poezio/bugs[our tracker] (or fixes such an
- issue), you can use “Fixes #BUGID” or “References #BUGID” to help with the
- tracking.
-
-
-Getting your code into poezio
------------------------------
-
-If you have code you want to contribute, you can:
-
-* Give us a patch and a description of what it does
-* Give us a link to a _git_ repo from which we can pull
-
-The code is of course reviewed and tested a bit, but we trust the contributors
-to submit good code. If we can’t integrate the given code into poezio (if it
-crashes or has some issues), if the size is small, we may tweak it ourselves
-and integrate it, and if not, you are of course free to take our advice into
-account and submit it again.
-
-
-If you have already submitted some code and plan to do more, you can ask us
- direct commit access on the main repo.
-