summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2014-03-23 08:27:18 +0100
committerSebastien Helleu <flashcode@flashtux.org>2014-03-23 08:27:18 +0100
commitea34976d4d1f4d4566c49a26958beff1dbe77db1 (patch)
tree414533aadcd35275b6cd0c19e9ddce999d271e57 /doc
parentaa3a82f2f2a4c1d9dcae672dabd4c539aadbbcdd (diff)
downloadweechat-ea34976d4d1f4d4566c49a26958beff1dbe77db1.zip
doc: update the contribute chapter in developer's guide
Diffstat (limited to 'doc')
-rw-r--r--doc/en/weechat_dev.en.txt21
-rw-r--r--doc/fr/weechat_dev.fr.txt21
-rw-r--r--doc/ja/weechat_dev.ja.txt21
3 files changed, 48 insertions, 15 deletions
diff --git a/doc/en/weechat_dev.en.txt b/doc/en/weechat_dev.en.txt
index f48abc11c..153943d63 100644
--- a/doc/en/weechat_dev.en.txt
+++ b/doc/en/weechat_dev.en.txt
@@ -923,7 +923,13 @@ Any patch for bug or new feature must be done on master branch, preferred way is
a Github pull request. A patch can also be sent by e-mail (made with `git diff`
or `git format-patch`).
-Format of commit message is the following:
+Format of commit message is the following (to close a GitHub issue):
+
+----
+component: fix a problem (closes #123)
+----
+
+For a Savannah bug:
----
component: fix a problem (bug #12345)
@@ -931,20 +937,25 @@ component: fix a problem (bug #12345)
Where 'component' is one of following:
-* WeeChat core: 'core' (files in directory 'src/' except 'doc' and 'plugins')
+* WeeChat core: 'core' (files in root directory, 'po/' and 'src/',
+ except 'src/plugins/')
* documentation files: 'doc' (files in directory 'doc/')
-* name of a plugin: 'irc', 'python', 'relay', ... (files in directory 'src/plugins/')
+* name of a plugin: 'irc', 'python', 'relay', ... (files in directory
+ 'src/plugins/')
Some rules to follow:
* use only English
* use infinitive form of verb
-* if commit is related to something in tracker (bug, task, patch), write it
- in parenthesis after the message (format: bug #12345, task #12345, patch #12345)
+* if commit is related to something in tracker, write it in parenthesis after
+ the message, with this format:
+** GitHub: closes #123
+** Savannah: bug #12345, task #12345, patch #12345
Examples of commit messages:
----
+irc: add command /unquiet (closes #36)
core: add callback "nickcmp" for nick comparison in buffers
irc: fix freeze when reading on socket with SSL enabled (bug #35097)
ruby: add detection of ruby version 1.9.3 in cmake
diff --git a/doc/fr/weechat_dev.fr.txt b/doc/fr/weechat_dev.fr.txt
index b8c11557d..2afedaee6 100644
--- a/doc/fr/weechat_dev.fr.txt
+++ b/doc/fr/weechat_dev.fr.txt
@@ -939,7 +939,13 @@ Tout patch pour un bug ou une nouvelle fonctionnalité doit être effectué sur
branche master, le format préféré étant une "pull request" sur Github. Un patch
peut aussi être envoyé par e-mail (fait avec `git diff` ou `git format-patch`).
-Le format du message de commit est le suivant :
+Le format du message de commit est le suivant (pour fermer un bug GitHub) :
+
+----
+component: fix a problem (closes #123)
+----
+
+Pour un bug Savannah :
----
component: fix a problem (bug #12345)
@@ -947,8 +953,8 @@ component: fix a problem (bug #12345)
Où 'component' est :
-* pour le cœur WeeChat : 'core' (les fichiers dans le répertoire 'src/', sauf
- 'doc' et 'plugins')
+* pour le cœur WeeChat : 'core' (les fichiers dans le répertoire racine, 'po/'
+ et 'src/', sauf 'src/plugins/')
* fichiers de documentation : 'doc' (fichiers dans le répertoire 'doc/')
* nom d'une extension : 'irc', 'python', 'relay', ... (fichiers dans le
répertoire 'src/plugins/')
@@ -957,12 +963,15 @@ Quelques règles à suivre :
* utilisez seulement l'anglais
* utilisez des verbes à l'infinitif
-* si le commit est relatif au tracker (bug, task, patch), écrivez-le entre
- parenthèses après le message (format: bug #12345, task #12345, patch #12345)
+* si le commit est relatif au tracker, écrivez-le entre parenthèses après le
+ message, avec ce format :
+** GitHub : closes #123
+** Savannah : bug #12345, task #12345, patch #12345
Exemples de messages de commit :
----
+irc: add command /unquiet (closes #36)
core: add callback "nickcmp" for nick comparison in buffers
irc: fix freeze when reading on socket with SSL enabled (bug #35097)
ruby: add detection of ruby version 1.9.3 in cmake
@@ -998,7 +1007,7 @@ $ msgcheck.py xx.po
----
[[build_autogen_files]]
-===== Construire les fichier auto-générés
+===== Construire les fichiers auto-générés
Les fichiers dans le répertoire 'doc/XX/autogen/' sont automatiquement générés
par le script 'doc/docgen.py'.
diff --git a/doc/ja/weechat_dev.ja.txt b/doc/ja/weechat_dev.ja.txt
index fc7806630..702b8e7c9 100644
--- a/doc/ja/weechat_dev.ja.txt
+++ b/doc/ja/weechat_dev.ja.txt
@@ -917,7 +917,14 @@ Git リポジトリはこの URL にあります: https://github.com/weechat/wee
リクエストを使って提出することを推奨します。パッチは電子メールで送信することも可能です
(`git diff` または `git format-patch` で作成してください)。
-コミットメッセージは以下のフォーマットに従ってください:
+// TRANSLATION MISSING
+Format of commit message is the following (to close a GitHub issue):
+
+----
+component: fix a problem (closes #123)
+----
+
+For a Savannah bug:
----
component: fix a problem (bug #12345)
@@ -925,7 +932,9 @@ component: fix a problem (bug #12345)
ここで 'component' は以下の 1 つです:
-* WeeChat コア: 'core' (ディレクトリ doc と plugins 以外の 'src/' ディレクトリに含まれるファイル)
+// TRANSLATION MISSING
+* WeeChat core: 'core' (files in root directory, 'po/' and 'src/',
+ except 'src/plugins/')
* 文書ファイル: 'doc' ('doc/' ディレクトリに含まれるファイル)
* プラグインの名前: 'irc'、'python'、'relay'、... ('src/plugins/' ディレクトリに含まれるファイル)
@@ -933,12 +942,16 @@ component: fix a problem (bug #12345)
* 英語を使ってください
* 動詞の原形を使ってください
-* コミットの内容がトラッカーに関するもの (バグ、タスク、パッチ)
- である場合には、カッコで括ったトラッカー番号をコミットメッセージの後につけてください (フォーマット: bug #12345、task #12345、patch #12345)
+// TRANSLATION MISSING
+* if commit is related to something in tracker, write it in parenthesis after
+ the message, with this format:
+** GitHub: closes #123
+** Savannah: bug #12345, task #12345, patch #12345
コミットメッセージの例:
----
+irc: add command /unquiet (closes #36)
core: add callback "nickcmp" for nick comparison in buffers
irc: fix freeze when reading on socket with SSL enabled (bug #35097)
ruby: add detection of ruby version 1.9.3 in cmake