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
64 changes: 64 additions & 0 deletions src/site/markdown/get-involved.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Getting Involved
author:
- Rahul Thakur
- Olivier Lamy
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->

# Getting Involved

Contributions are welcome. The full guide lives with the code: [CONTRIBUTING.md](https://github.com/codehaus-plexus/.github/blob/master/CONTRIBUTING.md). The short version is below.

## Where to ask

[GitHub issues](https://github.com/codehaus-plexus), 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](./index.html) 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.

## Building

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

## Code style

Formatting is enforced by the build, via [Spotless](https://github.com/diffplug/spotless) and [palantir-java-format](https://github.com/palantir/palantir-java-format). Don't hand-format, and don't reformat code you aren't otherwise touching. Before pushing:

```unknown
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.

## Licence headers

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.

## Pull requests

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.

## Security

Please do not open a public issue for a vulnerability. See [SECURITY.md](https://github.com/codehaus-plexus/.github/blob/master/SECURITY.md).

34 changes: 34 additions & 0 deletions src/site/markdown/ref/available-components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Available Plexus Components
author:
- Rahul Thakur
- Olivier Lamy
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->

# Available Plexus Components

**This page is out of date and is kept only so existing links to it keep working.**

The current list of Plexus libraries and components, with links to their sites, is on the [overview page](../index.html).

The list that used to be here described the components as they stood when Plexus was still an IoC container. Most of what it advertised no longer exists in any form — `plexus-cli`, `plexus-spring`, `plexus-contextualizer`, `plexus-xwork-integration`, `plexus-mail-sender`, `plexus-cache` and `plexus-swizzle` are all gone or archived — and it listed none of the components that are actually maintained today. Rather than leave that standing, the content has been removed and the overview page is now the single index.

102 changes: 0 additions & 102 deletions src/site/xdoc/get-involved.xml

This file was deleted.

52 changes: 0 additions & 52 deletions src/site/xdoc/ref/available-components.xml

This file was deleted.