summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2024-05-22 13:18:31 +0200
committerSébastien Helleu <flashcode@flashtux.org>2024-05-26 10:27:30 +0200
commit5d0784bd5259ba8516f01f8ed6bc8e7f47d6c454 (patch)
tree7ff9732fa0f2021047151df8bd252e32cc7c0e72
parent3653f4b7a2eb78c9898ffa345f4ecb2d45e63720 (diff)
downloadweechat-5d0784bd5259ba8516f01f8ed6bc8e7f47d6c454.zip
core: rename and convert Contributing.adoc to CONTRIBUTING.md
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yaml2
-rw-r--r--CMakeLists.txt2
-rw-r--r--CONTRIBUTING.md109
-rw-r--r--Contributing.adoc109
-rw-r--r--README.adoc2
-rw-r--r--debian-stable/weechat-core.docs2
-rw-r--r--doc/en/weechat_dev.en.adoc2
-rw-r--r--doc/fr/weechat_dev.fr.adoc2
-rw-r--r--doc/ja/weechat_dev.ja.adoc2
-rw-r--r--doc/sr/weechat_dev.sr.adoc2
-rw-r--r--weechat.cygport.in2
11 files changed, 118 insertions, 118 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
index 3f53bbe52..12d688363 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yaml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -9,7 +9,7 @@ body:
Before submitting a bug, please check that it has not already been reported by searching in [open and closed bugs](https://github.com/weechat/weechat/issues?q=is%3Aissue+label%3Abug).
If you don't use the latest version, please try if possible with the latest stable release to be sure the issue is still present and report the issue on this version.
- **IMPORTANT**: please do not report any security issue here, see [Contributing.adoc](https://github.com/weechat/weechat/blob/master/Contributing.adoc#security-reports).
+ **IMPORTANT**: please do not report any security issue here, see [CONTRIBUTING.md](https://github.com/weechat/weechat/blob/master/CONTRIBUTING.md#security-reports).
- type: textarea
id: bug-description
diff --git a/CMakeLists.txt b/CMakeLists.txt
index b5eb6a009..82bf3a9ef 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -323,7 +323,7 @@ if(CYGWIN)
install(FILES
"${CMAKE_CURRENT_SOURCE_DIR}/AUTHORS.adoc"
"${CMAKE_CURRENT_SOURCE_DIR}/CHANGELOG.md"
- "${CMAKE_CURRENT_SOURCE_DIR}/Contributing.adoc"
+ "${CMAKE_CURRENT_SOURCE_DIR}/CONTRIBUTING.md"
"${CMAKE_CURRENT_SOURCE_DIR}/README.adoc"
"${CMAKE_CURRENT_SOURCE_DIR}/UPGRADING.md"
DESTINATION "${DATAROOTDIR}/doc/${PROJECT_NAME}"
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..3a6e316a1
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,109 @@
+# Contributing to WeeChat
+
+## Reporting bugs
+
+First, some basic things:
+
+- Use only English to communicate with developers.
+- Search in issues if the same problem or feature request has already been
+ reported (a duplicate is waste of time for you and the developers!).
+- If you can, please check if the problem has been fixed in development version
+ (if you are using a stable release or old version).
+- Report only one bug or feature request per issue.
+
+### Security reports
+
+Please **DO NOT** file a GitHub issue for security related problems, but send an
+email to [security@weechat.org](mailto:security@weechat.org) instead.
+
+### Required info
+
+When reporting [issues](https://github.com/weechat/weechat/issues) on GitHub,
+please include:
+
+- Your **WeeChat version**: the output of `/v` in WeeChat, for example:
+ `WeeChat 1.7-dev (git: v1.6-6-g997f47f)`.\
+ If WeeChat does not start at all, please include the version displayed by
+ `weechat --help` (or the version installed with your package manager).
+- Your **operating system**: its name and version (examples: Linux Debian Bookworm,
+ FreeBSD 13.0, Windows/Cygwin 64-bit, Windows/Ubuntu 64-bit…).
+- The **steps to reproduce**: if possible, please include a reproducible example:
+ explain the steps which led you to the problem.\
+ It's even better if you can reproduce the problem with a new config (and no
+ scripts loaded): try `weechat --dir /tmp/weechat` and check if you have the
+ problem here.
+- The **gdb's backtrace** (only for a crash): if you can reproduce the crash
+ (or if you have a core file), please include the backtrace from gdb (look at
+ [User's guide](https://weechat.org/doc/weechat/user/#report_crashes) for more info).
+- The **actual result**.
+- The **expected result**: the correct result you are expecting.
+
+> [!IMPORTANT]
+> Most of times, the WeeChat crash log file (_weechat_crash_YYYYMMDD_xxx.log_)
+is **NOT USEFUL** to fix the bug, so please report this file **ONLY** if a developer
+asked you to send it (and be extremely careful, this file can contain personal
+data like passwords and contents of your chats).
+
+### Scripts related issues
+
+If you are using scripts, they can cause problems/crashes. To check if the
+problem is related to one script, try to unload them one by one (using
+command `/script unload <name>`).
+
+Many issues reported are in fact related to bugs in scripts, so please first
+check that before reporting any issue on WeeChat itself.
+
+If you think the problem comes from a specific script, please report the issue
+in the [scripts git repository](https://github.com/weechat/scripts/issues) instead.
+
+## Translations
+
+Pull requests on GitHub for fixes or new translations are welcome at any
+time, for [WeeChat](https://github.com/weechat/weechat) and the website
+[weechat.org](https://github.com/weechat/weechat.org).
+
+To start a translation in a new language (not yet supported), please look at
+[translations](https://weechat.org/doc/weechat/dev/#translations)
+in Developer's guide.
+
+## Feature requests
+
+WeeChat is under active development, so your idea may already have been
+implemented, or scheduled for a future version (you can check in
+[roadmap](https://weechat.org/dev/) or
+[milestones](https://github.com/weechat/weechat/milestones) on GitHub.
+
+Pull requests on GitHub are welcome for minor new features.
+
+For major new features, it's better to discuss about it in IRC
+(server: `irc.libera.chat`, channel `#weechat`).
+
+Before submitting any pull request, be sure you have read the
+[coding rules](https://weechat.org/doc/weechat/dev/#coding_rules)
+in Developer's guide, which contains info about styles used, naming convention
+and other useful info.
+
+## Semantic versioning
+
+Since version 4.0.0, WeeChat is following a "practical" semantic versioning.
+
+It is based on [Semantic Versioning](https://semver.org/) but in a less strict way:
+breaking changes in API with low user impact don't bump the major version.
+
+The version number is on three digits `X.Y.Z`, where:
+
+- `X` is the major version
+- `Y` is the minor version
+- `Z` is the patch version.
+
+Rules to increment the version number:
+
+- the **major version** number (`X`) is incremented only when intentional breaking changes
+ target feature areas that are actively consumed by users, scripts or C plugin API
+- the **minor version** number (`Y`) is incremented for any new release of WeeChat
+ that includes new features and bug fixes, possibly breaking API with low impact on users
+- the **patch version** number (`Z`) is reserved for releases that address severe bugs
+ or security issues found after the release.
+
+For more information, see the
+[specification](https://specs.weechat.org/specs/2023-003-practical-semantic-versioning.html).
diff --git a/Contributing.adoc b/Contributing.adoc
deleted file mode 100644
index f0b54e92c..000000000
--- a/Contributing.adoc
+++ /dev/null
@@ -1,109 +0,0 @@
-= Contributing to WeeChat
-:author: Sébastien Helleu
-:email: flashcode@flashtux.org
-:lang: en
-
-
-== Reporting bugs
-
-First, some basic things:
-
-* Use only English to communicate with developers.
-* Search in issues if the same problem or feature request has already been
- reported (a duplicate is waste of time for you and the developers!).
-* If you can, please check if the problem has been fixed in development version
- (if you are using a stable release or old version).
-* Report only one bug or feature request per issue.
-
-=== Security reports
-
-Please *DO NOT* file a GitHub issue for security related problems, but send an
-email to <security@weechat.org> instead.
-
-=== Required info
-
-When reporting https://github.com/weechat/weechat/issues[issues] on GitHub,
-please include:
-
-* Your *WeeChat version*: the output of `/v` in WeeChat, for example:
- _WeeChat 1.7-dev (git: v1.6-6-g997f47f)_. +
- If WeeChat does not start at all, please include the version displayed by
- `weechat --help` (or the version installed with your package manager).
-* Your *operating system*: its name and version (examples: Linux Debian Bookworm,
- FreeBSD 13.0, Windows/Cygwin 64-bit, Windows/Ubuntu 64-bit...).
-* The *steps to reproduce*: if possible, please include a reproducible example:
- explain the steps which led you to the problem. +
- It's even better if you can reproduce the problem with a new config (and no
- scripts loaded): try `weechat --dir /tmp/weechat` and check if you have the
- problem here.
-* The *gdb's backtrace* (only for a crash): if you can reproduce the crash
- (or if you have a core file), please include the backtrace from gdb (look at
- https://weechat.org/doc/weechat/user/#report_crashes[User's guide] for more info).
-* The *actual result*.
-* The *expected result*: the correct result you are expecting.
-
-[IMPORTANT]
-Most of times, the WeeChat crash log file (_weechat_crash_YYYYMMDD_xxx.log_) is
-*NOT USEFUL* to fix the bug, so please report this file *ONLY* if a developer
-asked you to send it (and be extremely careful, this file can contain personal
-data like passwords and contents of your chats).
-
-=== Scripts related issues
-
-If you are using scripts, they can cause problems/crashes. To check if the
-problem is related to one script, try to unload them one by one (using
-command `/script unload <name>`).
-
-Many issues reported are in fact related to bugs in scripts, so please first
-check that before reporting any issue on WeeChat itself.
-
-If you think the problem comes from a specific script, please report the issue
-in the https://github.com/weechat/scripts/issues[scripts git repository]
-instead.
-
-== Translations
-
-Pull requests on GitHub for fixes or new translations are welcome at any
-time, for https://github.com/weechat/weechat[WeeChat] and the website
-https://github.com/weechat/weechat.org[weechat.org].
-
-To start a translation in a new language (not yet supported), please look at
-https://weechat.org/doc/weechat/dev/#translations[translations]
-in Developer's guide.
-
-== Feature requests
-
-WeeChat is under active development, so your idea may already have been
-implemented, or scheduled for a future version (you can check in
-https://weechat.org/dev/[roadmap] or
-https://github.com/weechat/weechat/milestones[milestones] on GitHub.
-
-Pull requests on GitHub are welcome for minor new features.
-
-For major new features, it's better to discuss about it in IRC
-(server: _irc.libera.chat_, channel _#weechat_).
-
-Before submitting any pull request, be sure you have read the
-https://weechat.org/doc/weechat/dev/#coding_rules[coding rules]
-in Developer's guide, which contains info about styles used, naming convention
-and other useful info.
-
-== Semantic versioning
-
-Since version 4.0.0, WeeChat is following a "practical" semantic versioning.
-
-It is based on https://semver.org/[Semantic Versioning] but in a less strict way: breaking changes in API with low user impact don't bump the major version.
-
-The version number is on three digits `X.Y.Z`, where:
-
-* `X` is the major version
-* `Y` is the minor version
-* `Z` is the patch version.
-
-Rules to increment the version number:
-
-* the *major version* number (`X`) is incremented only when intentional breaking changes target feature areas that are actively consumed by users, scripts or C plugin API
-* the *minor version* number (`Y`) is incremented for any new release of WeeChat that includes new features and bug fixes, possibly breaking API with low impact on users
-* the *patch version* number (`Z`) is reserved for releases that address severe bugs or security issues found after the release.
-
-For more information, see the https://specs.weechat.org/specs/2023-003-practical-semantic-versioning.html[specification].
diff --git a/README.adoc b/README.adoc
index 3a0d9d89d..e3b264c4d 100644
--- a/README.adoc
+++ b/README.adoc
@@ -45,7 +45,7 @@ For detailed instructions, please check the https://weechat.org/doc/weechat/user
== Semantic versioning
-WeeChat is following a "practical" semantic versioning, see file link:Contributing.adoc#semantic-versioning[Contributing.adoc].
+WeeChat is following a "practical" semantic versioning, see file link:CONTRIBUTING.md#semantic-versioning[CONTRIBUTING.md].
== Copyright
diff --git a/debian-stable/weechat-core.docs b/debian-stable/weechat-core.docs
index 2330bcdad..edb38527d 100644
--- a/debian-stable/weechat-core.docs
+++ b/debian-stable/weechat-core.docs
@@ -1,4 +1,4 @@
AUTHORS.adoc
-Contributing.adoc
+CONTRIBUTING.md
README.adoc
UPGRADING.md
diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc
index 6c0b90be4..820fbef32 100644
--- a/doc/en/weechat_dev.en.adoc
+++ b/doc/en/weechat_dev.en.adoc
@@ -1189,7 +1189,7 @@ Where _component_ is one of following:
| core
| AUTHORS.adoc +
CHANGELOG.md +
- Contributing.adoc +
+ CONTRIBUTING.md +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
diff --git a/doc/fr/weechat_dev.fr.adoc b/doc/fr/weechat_dev.fr.adoc
index da71d1ff7..0869a7113 100644
--- a/doc/fr/weechat_dev.fr.adoc
+++ b/doc/fr/weechat_dev.fr.adoc
@@ -1209,7 +1209,7 @@ Où _composant_ est :
| core
| AUTHORS.adoc +
CHANGELOG.md +
- Contributing.adoc +
+ CONTRIBUTING.md +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
diff --git a/doc/ja/weechat_dev.ja.adoc b/doc/ja/weechat_dev.ja.adoc
index 00374a5b0..03592d6a7 100644
--- a/doc/ja/weechat_dev.ja.adoc
+++ b/doc/ja/weechat_dev.ja.adoc
@@ -1325,7 +1325,7 @@ _component_ には以下から 1 つ選んで記入してください:
| core
| AUTHORS.adoc +
CHANGELOG.md +
- Contributing.adoc +
+ CONTRIBUTING.md +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
diff --git a/doc/sr/weechat_dev.sr.adoc b/doc/sr/weechat_dev.sr.adoc
index 14aca9440..88f100780 100644
--- a/doc/sr/weechat_dev.sr.adoc
+++ b/doc/sr/weechat_dev.sr.adoc
@@ -1160,7 +1160,7 @@ server->hook_timer_sasl = weechat_hook_timer (timeout * 1000,
| core
| AUTHORS.adoc +
CHANGELOG.md +
- Contributing.adoc +
+ CONTRIBUTING.md +
.github/FUNDING.yml +
.github/ISSUE_TEMPLATE/* +
icons/* +
diff --git a/weechat.cygport.in b/weechat.cygport.in
index 081368b69..d2262d7e0 100644
--- a/weechat.cygport.in
+++ b/weechat.cygport.in
@@ -117,7 +117,7 @@ weechat_CONTENTS="
usr/share/man/
usr/share/doc/weechat/AUTHORS.adoc
usr/share/doc/weechat/CHANGELOG.md
- usr/share/doc/weechat/Contributing.adoc
+ usr/share/doc/weechat/CONTRIBUTING.md
usr/share/doc/weechat/COPYING
usr/share/doc/weechat/README.adoc
usr/share/doc/weechat/UPGRADING.md