"Fossies" - the Fresh Open Source Software Archive
Member "apache-log4j-2.12.4-src/CONTRIBUTING.md" (20 Dec 2021, 3786 Bytes) of package /linux/misc/apache-log4j-2.12.4-src.tar.gz:
As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format).
Alternatively you can here view
the uninterpreted source code file.
A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs"
side-by-side code changes report for "CONTRIBUTING.md": 2.19.0_vs_2.20.0
A hint: This file contains one or more very long lines, so maybe it is better readable using the pure text view mode that shows the contents as wrapped lines within the browser window.
Contributing to Apache Log4j
You have found a bug or you have an idea for a cool new feature?
Contributing code is a great way to give something back to the open
source community. Before you dig right into the code there are a few
guidelines that we need contributors to follow so that we can have a
chance of keeping on top of things.
- Make sure you have a JIRA
- Make sure you have a GitHub
- If you’re planning to implement a new feature it makes sense to
discuss your changes on the dev list
first. This way you can make sure you’re not wasting your time on
something that isn’t considered to be in Apache Log4j’s scope.
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a
- Make sure you fill in the earliest version that you know has the
- Fork the repository on GitHub.
- Create a topic branch from where you want to base your work (this is
usually the master branch).
- Make commits of logical units.
- Respect the original code style:
- Only use spaces for indentation.
- Create minimal diffs - disable on save actions like reformat source
code or organize imports. If you feel the source code should be
reformatted create a separate PR for this change.
- Check for unnecessary whitespace with git diff –check before
- Make sure your commit messages are in the proper format. Your commit
message should contain the key of the JIRA issue.
- Make sure you have added the necessary tests for your changes.
- Run all the tests with
mvn clean verify to assure
nothing else was accidentally broken.
Making Trivial Changes
For changes of a trivial nature to comments and documentation, it is
not always necessary to create a new ticket in JIRA. In this case, it is
appropriate to start the first line of a commit with ‘(doc)’ instead of
a ticket number.
- Sign the Contributor
License Agreement if you haven’t already.
- Push your changes to a topic branch in your fork of the
- Submit a pull request to the repository in the apache
- Update your JIRA ticket and include a link to the pull request in