You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[A clear and concise description of what the pull request is for along with a reference to the associated issue IDs, if they exist.]
1
+
**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.
2
+
3
+
> [!IMPORTANT]
4
+
> Base your changes on `2.x` branch if you are targeting Log4j 2; use `main` otherwise.
2
5
3
6
## Checklist
4
7
5
-
* Base your changes on `2.x` branch if you are targeting Log4j 2; use `main` otherwise
6
-
*`./mvnw verify` succeeds (if it fails due to code formatting issues reported by Spotless, simply run `./mvnw spotless:apply` and retry)
7
-
* Non-trivial changes contain an entry file in the `src/changelog/.2.x.x` directory
8
-
* 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)
8
+
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.
9
+
10
+
### ✅ Required checks
11
+
12
+
-[ ]**License**: I confirm that my changes are submitted under the [Apache License, Version 2.0](https://apache.org/licenses/LICENSE-2.0).
13
+
-[ ]**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)).
14
+
-[ ]**Code formatting**: The code is formatted according to the project’s style guide.
15
+
<details>
16
+
<summary>How to check and fix formatting</summary>
17
+
18
+
- To **check** formatting: `./mvnw spotless:check`
19
+
- To **fix** formatting: `./mvnw spotless:apply`
20
+
21
+
See [the build instructions](https://logging.apache.org/log4j/2.x/development.html#building) for details.
22
+
</details>
23
+
-[ ]**Build & Test**: I verified that the project builds and all unit tests pass.
24
+
<details>
25
+
<summary>How to build the project</summary>
26
+
27
+
Run: `./mvnw verify`
28
+
29
+
See [the build instructions](https://logging.apache.org/log4j/2.x/development.html#building) for details.
30
+
</details>
31
+
32
+
### 🧪 Tests (select one)
33
+
34
+
-[ ] I have added or updated tests to cover my changes.
35
+
-[ ] No additional tests are needed for this change.
36
+
37
+
### 📝 Changelog (select one)
38
+
39
+
-[ ] 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)).
40
+
-[ ] This is a trivial change and does not require a changelog entry.
0 commit comments