"Fossies" - the Fresh Open Source Software Archive

Member "apache-maven-3.6.3/CONTRIBUTING.md" (7 Nov 2019, 4818 Bytes) of package /linux/misc/apache-maven-3.6.3-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 or download 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": 3.6.0_vs_3.6.1.

Contributing to Apache Maven

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.

Some of the ideas are documented in the Maven Wiki which might be interesting to read and for further discussion.

Getting Started

Making and Submitting Changes

We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us: + Create a topic branch from where you want to base your work (this is usually the master branch). Push your changes to a topic branch in your fork of the repository. + Make commits of logical units. + Respect the original code style: by using the same codestyle, patches should only highlight the actual difference, not being disturbed by any formatting issues: + 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 committing. + Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.

[MNG-XXX] - Subject of the JIRA Ticket
 Optional supplemental description.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement.

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.

Additional Resources