Skip to content

Commit 43e51ad

Browse files
committed
Development-related documentation improvements
1 parent 2bc484c commit 43e51ad

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
* `./mvnw verify` succeeds (if it fails due to code formatting issues reported by Spotless, simply run `./mvnw spotless:apply` and retry)
77
* Non-trivial changes contain an entry file in the `src/changelog/.2.x.x` directory
88
* Tests for the changes are provided
9-
* [Commits are signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) (optional, but highly recommended)
9+
* [**All commits must be signed!**](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)

README.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ https://github.com/apache/logging-log4j2/security/code-scanning[image:https://gi
2121
2222
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.
2323
For further information (support, download, etc.) see https://logging.apache.org/log4j[the project website].
24+
25+
[#development]
26+
== Development
27+
28+
Looking for *build instructions*, branching scheme, and other developer resources?
29+
See https://logging.apache.org/log4j/2.x/development.html[the Development page] at the website.

src/site/antora/modules/ROOT/pages/development.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,10 @@ Pitch it in a {logging-services-url}/support.html#discussions-maintainer[maintai
8383
[#committer]
8484
== I am a committer. How shall I push my changes?
8585
86-
. Is it something trivial?
87-
Go ahead and push it.
86+
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.
87+
88+
Make sure a changelog entry is attached, and `./mvnw verify site` succeeds.
8889
89-
. Otherwise, submit a pull request.
90-
Make sure a changelog entry is attached and `./mvnw verify site` succeeds.
91-
+
9290
[TIP]
9391
====
9492
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.

0 commit comments

Comments
 (0)