1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-25 04:16:38 +02:00

doc/dev: add table with list of components for git commit message

This commit is contained in:
Sébastien Helleu
2022-02-20 17:31:25 +01:00
parent d359e8135e
commit 40ff9beb10
4 changed files with 389 additions and 52 deletions
+89 -12
View File
@@ -1121,18 +1121,95 @@ component: fix a problem (closes #123)
Where _component_ is one of following:
* WeeChat core: `core` (files in root directory, _po/_ and _src/_, except _src/plugins/_)
* documentation:
** `doc`: general doc updates, for example build
** `doc/man`: man pages
** `doc/faq`: frequently asked questions (FAQ)
** `doc/quickstart`: quickstart guide
** `doc/user`: user's guide
** `doc/scripting`: scripting guide
** `doc/api`: plugin API reference
** `doc/relay`: relay protocol
** `doc/dev`: developer's guide
* plugins: `irc`, `python`, `relay`, ... (files in directory _src/plugins/_)
[width="100%",cols="1m,4m,5",options="header"]
|===
| Component | Files | Description
| core |
AUTHORS.adoc +
ChangeLog.adoc +
Contributing.adoc +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
po/* +
README.adoc +
ReleaseNotes.adoc +
src/core/* +
src/gui/* +
version.sh +
weechat.desktop |
WeeChat core
| build |
autogen.sh +
CMakeLists.txt +
cmake/* +
configure.ac +
Makefile.am +
tools/* +
weechat.cygport.in +
weechat.spec |
Build
| ci |
.github/workflows/* |
Continuous integration
| debian |
debian-devel/* +
debian-stable/* |
Debian packaging
| tests |
tests/* |
Tests
| doc |
doc/* |
General doc updates, for example build
| doc/man |
doc/xx/weechat.1.xx.adoc +
doc/xx/weechat-headless.1.xx.adoc |
Man pages
| doc/faq |
doc/xx/weechat_faq.xx.adoc |
Frequently asked questions (FAQ)
| doc/quickstart |
doc/xx/weechat_quickstart.xx.adoc |
Quickstart guide
| doc/user |
doc/xx/weechat_user.xx.adoc |
User's guide
| doc/scripting |
doc/xx/weechat_scripting.xx.adoc |
Scripting guide
| doc/api |
doc/xx/weechat_plugin_api.xx.adoc |
Plugin API reference
| doc/relay |
doc/xx/weechat_relay_protocol.xx.adoc |
Relay protocol
| doc/dev |
doc/xx/weechat_dev.en.adoc |
Developer's guide
| irc +
python +
relay +
… |
src/plugins/<name>/* |
Plugin
|===
Some rules to follow:
+91 -16
View File
@@ -1136,25 +1136,100 @@ Le format du message de commit est le suivant (avec fermeture automatique
du bug GitHub) :
----
component: fix a problem (closes #123)
composant: fix a problem (closes #123)
----
Où _component_ est :
Où _composant_ est :
* cœur de WeeChat : `core`
(les fichiers dans le répertoire racine, _po/_ et _src/_, sauf _src/plugins/_)
* documentation :
** `doc` : mise à jour générales sur la documentation, par exemple la construction
** `doc/man` : pages de manuel
** `doc/faq` : questions fréquemment posées (FAQ)
** `doc/quickstart` : guide de démarrage rapide
** `doc/user` : guide utilisateur
** `doc/scripting` : guide pour scripts
** `doc/api` : référence extension API
** `doc/relay` : protocole relay
** `doc/dev` : guide du développeur
* extensions : `irc`, `python`, `relay`, ...
(fichiers dans le répertoire _src/plugins/_)
[width="100%",cols="1m,4m,5",options="header"]
|===
| Composant | Fichiers | Description
| core |
AUTHORS.adoc +
ChangeLog.adoc +
Contributing.adoc +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
po/* +
README.adoc +
ReleaseNotes.adoc +
src/core/* +
src/gui/* +
version.sh +
weechat.desktop |
cœur de WeeChat
| build |
autogen.sh +
CMakeLists.txt +
cmake/* +
configure.ac +
Makefile.am +
tools/* +
weechat.cygport.in +
weechat.spec |
Construction
| ci |
.github/workflows/* |
Intégration continue
| debian |
debian-devel/* +
debian-stable/* |
Empaquetage Debian
| tests |
tests/* |
Tests
| doc |
doc/* |
Mises à jour générales sur la documentation, par exemple la construction
| doc/man |
doc/xx/weechat.1.xx.adoc +
doc/xx/weechat-headless.1.xx.adoc |
Pages de manuel
| doc/faq |
doc/xx/weechat_faq.xx.adoc |
Questions fréquemment posées (FAQ)
| doc/quickstart |
doc/xx/weechat_quickstart.xx.adoc |
Guide de démarrage rapide
| doc/user |
doc/xx/weechat_user.xx.adoc |
Guide utilisateur
| doc/scripting |
doc/xx/weechat_scripting.xx.adoc |
Guide pour scripts
| doc/api |
doc/xx/weechat_plugin_api.xx.adoc |
Référence extension API
| doc/relay |
doc/xx/weechat_relay_protocol.xx.adoc |
Protocole relay
| doc/dev |
doc/xx/weechat_dev.en.adoc |
Guide du développeur
| irc +
python +
relay +
… |
src/plugins/<name>/* |
Extension
|===
Quelques règles à suivre :
+104 -12
View File
@@ -1174,19 +1174,111 @@ component: fix a problem (closes #123)
_component_ には以下から 1 つ選んで記入してください:
[width="100%",cols="1m,4m,5",options="header"]
|===
// TRANSLATION MISSING
* WeeChat core: `core` (files in root directory, _po/_ and _src/_, except _src/plugins/_)
* documentation:
** `doc`: general doc updates, for example build
** `doc/man`: man pages
** `doc/faq`: frequently asked questions (FAQ)
** `doc/quickstart`: quickstart guide
** `doc/user`: user's guide
** `doc/scripting`: scripting guide
** `doc/api`: plugin API reference
** `doc/relay`: relay protocol
** `doc/dev`: developer's guide
* plugins: `irc`, `python`, `relay`, ... (files in directory _src/plugins/_)
| Component | Files | Description
| core |
AUTHORS.adoc +
ChangeLog.adoc +
Contributing.adoc +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
po/* +
README.adoc +
ReleaseNotes.adoc +
src/core/* +
src/gui/* +
version.sh +
weechat.desktop |
// TRANSLATION MISSING
WeeChat core
| build |
autogen.sh +
CMakeLists.txt +
cmake/* +
configure.ac +
Makefile.am +
tools/* +
weechat.cygport.in +
weechat.spec |
// TRANSLATION MISSING
Build
| ci |
.github/workflows/* |
// TRANSLATION MISSING
Continuous integration
| debian |
debian-devel/* +
debian-stable/* |
// TRANSLATION MISSING
Debian packaging
| tests |
tests/* |
// TRANSLATION MISSING
Tests
| doc |
doc/* |
// TRANSLATION MISSING
General doc updates, for example build
| doc/man |
doc/xx/weechat.1.xx.adoc +
doc/xx/weechat-headless.1.xx.adoc |
// TRANSLATION MISSING
Man pages
| doc/faq |
doc/xx/weechat_faq.xx.adoc |
// TRANSLATION MISSING
Frequently asked questions (FAQ)
| doc/quickstart |
doc/xx/weechat_quickstart.xx.adoc |
// TRANSLATION MISSING
Quickstart guide
| doc/user |
doc/xx/weechat_user.xx.adoc |
// TRANSLATION MISSING
User's guide
| doc/scripting |
doc/xx/weechat_scripting.xx.adoc |
// TRANSLATION MISSING
Scripting guide
| doc/api |
doc/xx/weechat_plugin_api.xx.adoc |
// TRANSLATION MISSING
Plugin API reference
| doc/relay |
doc/xx/weechat_relay_protocol.xx.adoc |
// TRANSLATION MISSING
Relay protocol
| doc/dev |
doc/xx/weechat_dev.en.adoc |
// TRANSLATION MISSING
Developer's guide
| irc +
python +
relay +
… |
src/plugins/<name>/* |
// TRANSLATION MISSING
Plugin
|===
以下のルールに従ってください:
+105 -12
View File
@@ -1088,18 +1088,111 @@ Git репозиторијум се налази на следећој URL ад
Где је _компонента_ једно од следећег:
* WeeChat језгро: `core` (фајлови у кореном директоријуму, _po/_ и _src/_, осим _src/plugins/_)
* документација:
** `doc`: општа ажурирања документације, на пример изградња
** `doc/man`: man странице
** `doc/faq`: често постављана питања (ЧПП)
** `doc/quickstart`: водич за брзи почетак
** `doc/user`: корисничко упутство
** `doc/scripting`: водич за скриптовање
** `doc/api`: референтни приручник API додатака
** `doc/relay`: релеј протокол
** `doc/dev`: водич за програмере
* додаци: `irc`, `python`, `relay`, ... (фајлови у директоријуму _src/plugins/_)
[width="100%",cols="1m,4m,5",options="header"]
|===
// TRANSLATION MISSING
| Component | Files | Description
| core |
AUTHORS.adoc +
ChangeLog.adoc +
Contributing.adoc +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
po/* +
README.adoc +
ReleaseNotes.adoc +
src/core/* +
src/gui/* +
version.sh +
weechat.desktop |
// TRANSLATION MISSING
WeeChat core
| build |
autogen.sh +
CMakeLists.txt +
cmake/* +
configure.ac +
Makefile.am +
tools/* +
weechat.cygport.in +
weechat.spec |
// TRANSLATION MISSING
Build
| ci |
.github/workflows/* |
// TRANSLATION MISSING
Continuous integration
| debian |
debian-devel/* +
debian-stable/* |
// TRANSLATION MISSING
Debian packaging
| tests |
tests/* |
// TRANSLATION MISSING
Tests
| doc |
doc/* |
// TRANSLATION MISSING
General doc updates, for example build
| doc/man |
doc/xx/weechat.1.xx.adoc +
doc/xx/weechat-headless.1.xx.adoc |
// TRANSLATION MISSING
Man pages
| doc/faq |
doc/xx/weechat_faq.xx.adoc |
// TRANSLATION MISSING
Frequently asked questions (FAQ)
| doc/quickstart |
doc/xx/weechat_quickstart.xx.adoc |
// TRANSLATION MISSING
Quickstart guide
| doc/user |
doc/xx/weechat_user.xx.adoc |
// TRANSLATION MISSING
User's guide
| doc/scripting |
doc/xx/weechat_scripting.xx.adoc |
// TRANSLATION MISSING
Scripting guide
| doc/api |
doc/xx/weechat_plugin_api.xx.adoc |
// TRANSLATION MISSING
Plugin API reference
| doc/relay |
doc/xx/weechat_relay_protocol.xx.adoc |
// TRANSLATION MISSING
Relay protocol
| doc/dev |
doc/xx/weechat_dev.en.adoc |
// TRANSLATION MISSING
Developer's guide
| irc +
python +
relay +
… |
src/plugins/<name>/* |
// TRANSLATION MISSING
Plugin
|===
Нека правила која треба да поштујете: