diff --git a/src/site/site.xml b/src/site/site.xml index 20d6388..30cc192 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -46,7 +46,10 @@ under the License. - + + @@ -71,6 +74,8 @@ under the License. + + diff --git a/src/site/xdoc/get-involved.xml b/src/site/xdoc/get-involved.xml index bb32ddb..c68ae5d 100644 --- a/src/site/xdoc/get-involved.xml +++ b/src/site/xdoc/get-involved.xml @@ -1,64 +1,102 @@ - + + + - Community - Getting Involved - Rahul Thakur - Olivier Lamy + Getting Involved + Rahul Thakur + Olivier Lamy + -
- -

You can contribute: -

    -
  • by asking questions and sharing ideas on Plexus mailing lists -
    • -
  • by picking up issues of interest and submitting patches with Plexus team.
    • -
+
+ +

+ Contributions are welcome. The full guide lives with the code: + CONTRIBUTING.md. + The short version is below. +

+ + +

+ GitHub issues, on the repository concerned. + That is where the maintainers are. There is no Plexus mailing list — if you find one referenced + in older documentation on this site, it is defunct. +

+

+ Each project on the overview page links to its own repository. If you + aren't sure which one owns the behaviour you're seeing, open the issue wherever seems closest + and we'll move it. +

+ + + +

+ mvn verify. No profile or local setup is required. CI builds across JDK 8, 21 and 25 + on Linux, Windows and macOS.

- -

Before reporting please chose the correct project on Github

+ + +

+ Formatting is enforced by the build, via + Spotless and + palantir-java-format. Don't hand-format, + and don't reformat code you aren't otherwise touching. Before pushing: +

+ mvn spotless:apply +

+ If CI fails on spotless:check, running that command and committing the result is the + whole fix. +

+

+ This page previously offered maven-eclipse-codestyle.xml and + maven-idea-codestyle.xml for import into your IDE. Those predate Spotless and no longer + match what the build enforces, so they are no longer linked from here. The files themselves are still + served, so any existing link to them keeps working. +

- -

First you need to create an issue on Github in the correct project.

-
-

If your patch is a improvement or a new feature : add a junit.

+ + +

+ New files take the standard header used by the files around them — Apache-2.0 for everything except + Modello, which is MIT. Please do not update or normalise existing copyright headers, including the + older Codehaus Foundation ones; they record who contributed what. +

- -

All sources must contain the following license header : - -/* - * Copyright 2007 The Codehaus Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - + + +

+ One concern per pull request, a test where the change is testable, and an explanation of why in + the description. These libraries are consumed transitively across most of the Maven plugin ecosystem, + so changes to public API need discussion in an issue first — deprecate rather than remove.

- -

The following sections show how to set up the code style for Maven in IDEA and Eclipse. It is strongly preferred that patches use this style before they are spplied

- -

- Download maven-idea-codestyle.xml and copy it to ~/.IntelliJIDEA/config/codestyles then restart IDEA. On Windows, try C:\Documents and Settings<username>\.IntelliJIDEA\config\codestyles -

-

After this, restart IDEA and open the settings to select the new code style.

- - -

Download maven-eclipse-codestyle.xml -

-

After this, select Window > Preferences, and open up the configuration for Java > Code Style > Code Formatter. Click on the button labeled Import... and select the file you downloaded. Give the style a name, and click OK. -

- + + +

+ Please do not open a public issue for a vulnerability. See + SECURITY.md. +

+