Skip to content

Improve development-related documentation #3677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2025
Merged

Improve development-related documentation #3677

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43e51ad
Development-related documentation improvements
vy May 20, 2025
0ee4732
Revamped PR template
vy Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 6 additions & 0 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
8 changes: 3 additions & 5 deletions src/site/antora/modules/ROOT/pages/development.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down