Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 37 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,40 @@
[A clear and concise description of what the pull request is for along with a reference to the associated issue IDs, if they exist.]
**INSERT HERE** a clear and concise description of what the pull request is for along with a reference to the associated issue IDs, if they exist.

> [!IMPORTANT]
> Base your changes on `2.x` branch if you are targeting Log4j 2; use `main` otherwise.

## Checklist

* Base your changes on `2.x` branch if you are targeting Log4j 2; use `main` otherwise
* `./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)
Before we can review and merge your changes, please go through the checklist below. If you're still working on some items, feel free to submit your pull request as a draft—our CI will help guide you through the remaining steps.

### ✅ Required checks

- [ ] **License**: I confirm that my changes are submitted under the [Apache License, Version 2.0](https://apache.org/licenses/LICENSE-2.0).
- [ ] **Commit signatures**: All commits are signed and verifiable. (See [GitHub Docs on Commit Signature Verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)).
- [ ] **Code formatting**: The code is formatted according to the project’s style guide.
<details>
<summary>How to check and fix formatting</summary>

- To **check** formatting: `./mvnw spotless:check`
- To **fix** formatting: `./mvnw spotless:apply`

See [the build instructions](https://logging.apache.org/log4j/2.x/development.html#building) for details.
</details>
- [ ] **Build & Test**: I verified that the project builds and all unit tests pass.
<details>
<summary>How to build the project</summary>

Run: `./mvnw verify`

See [the build instructions](https://logging.apache.org/log4j/2.x/development.html#building) for details.
</details>

### 🧪 Tests (select one)

- [ ] I have added or updated tests to cover my changes.
- [ ] No additional tests are needed for this change.

### 📝 Changelog (select one)

- [ ] I added a changelog entry in `src/changelog/.2.x.x`. (See [Changelog Entry File Guide](https://logging.apache.org/log4j/tools/log4j-changelog.html#changelog-entry-file)).
- [ ] This is a trivial change and does not require a changelog entry.
6 changes: 6 additions & 0 deletions README.adoc
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
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