You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2025/05/20 07:40:20 UTC

(logging-log4j2) 01/01: Development-related documentation improvements

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch dev-doc
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git

commit 43e51adc3de00e2a639919ea85d4dca3e46cb694
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Tue May 20 09:40:00 2025 +0200

    Development-related documentation improvements
---
 .github/pull_request_template.md                    | 2 +-
 README.adoc                                         | 6 ++++++
 src/site/antora/modules/ROOT/pages/development.adoc | 8 +++-----
 3 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1cea95c461..95b2dedd8b 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -6,4 +6,4 @@
 * `./mvnw verify` succeeds (if it fails due to code formatting issues reported by Spotless, simply run `./mvnw spotless:apply` and retry)
 * Non-trivial changes contain an entry file in the `src/changelog/.2.x.x` directory
 * Tests for the changes are provided
-* [Commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) (optional, but highly recommended)
+* [**All commits must be signed!**](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
diff --git a/README.adoc b/README.adoc
index 9fd8d82799..d7d9bd39f6 100644
--- a/README.adoc
+++ b/README.adoc
@@ -21,3 +21,9 @@ https://github.com/apache/logging-log4j2/security/code-scanning[image:https://gi
 
 Apache Log4j is a versatile, industrial-grade Java logging framework composed of an API, its implementation,  and components to assist the deployment for various use cases.
 For further information (support, download, etc.) see https://logging.apache.org/log4j[the project website].
+
+[#development]
+== Development
+
+Looking for *build instructions*, branching scheme, and other developer resources?
+See https://logging.apache.org/log4j/2.x/development.html[the Development page] at the website.
diff --git a/src/site/antora/modules/ROOT/pages/development.adoc b/src/site/antora/modules/ROOT/pages/development.adoc
index edc861ede6..9c35dd393a 100644
--- a/src/site/antora/modules/ROOT/pages/development.adoc
+++ b/src/site/antora/modules/ROOT/pages/development.adoc
@@ -83,12 +83,10 @@ Pitch it in a {logging-services-url}/support.html#discussions-maintainer[maintai
 [#committer]
 == I am a committer. How shall I push my changes?
 
-. Is it something trivial?
-Go ahead and push it.
+As per https://lists.apache.org/thread/rx2hgc5mwql06yzwz2j8wkp8z6nmdcqk[the PMC resolution on 2025-04-10], all changes must be submitted in a pull request and undergo peer review.
+
+Make sure a changelog entry is attached, and `./mvnw verify site` succeeds.
 
-. Otherwise, submit a pull request.
-Make sure a changelog entry is attached and `./mvnw verify site` succeeds.
-+
 [TIP]
 ====
 You are strongly advised to spar with another maintainer first (see {logging-services-url}/support.html#discussions-maintainer[maintainer discussion channels]) before starting to code.