Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarification in README - maintained versions, issues and PR creation #832

Merged
merged 1 commit into from
Dec 1, 2022
Merged

Clarification in README - maintained versions, issues and PR creation #832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions .github/workflows/maven.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ jobs:
uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
with:
ff-goal: '-P run-its install' # site use project version for reporting
ff-maven: "3.8.6" # Maven version for fail-fast-build
verify-goal: '-P run-its install' # should be the same as for first build
maven-matrix: '[ "3.2.5", "3.8.6" ]' # Maven versions matrix for verify builds

deploy:
name: Deploy
Expand Down
52 changes: 38 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,68 @@ This is the [versions-maven-plugin](http://www.mojohaus.org/versions-maven-plugi
[![Maven Central](https://img.shields.io/maven-central/v/org.codehaus.mojo/versions-maven-plugin.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.codehaus.mojo/versions-maven-plugin)
[![Build Status](https://github.com/mojohaus/versions-maven-plugin/workflows/GitHub%20CI/badge.svg?branch=master)](https://github.com/mojohaus/versions-maven-plugin/actions/workflows/maven.yml?query=branch%3Amaster)

## Maintained versions

Versions Maven Plugin requires Maven 3.2.5+ and JDK 1.8+

However, we maintain the latest Plugin version with the latest Maven.

We execute tests against different operating systems and JDKs
by [GitHub Actions](https://github.com/mojohaus/versions-maven-plugin/actions/workflows/maven.yml?query=branch%3Amaster)

## Contributing

### Creating Issues

If you find a problem please create an
[issue in the ticket](https://github.com/mojohaus/versions-maven-plugin/issues)
If you find a problem please first search current opened and closed issues and pull requests.
It can be that someone already has reported similar.

You can also check current [milestone](https://github.com/mojohaus/versions-maven-plugin/milestones)
in order to see what will be in next release.

Only when you can not find similar issue please create a new one in the
[ticket system](https://github.com/mojohaus/versions-maven-plugin/issues)
and describe what is going wrong or what you expect to happen.

If you have a full working example or a log file this is also helpful.

You should of course describe only a single issue in a single ticket and not
mixing up several different things into a single issue.
mixing up several things into a single issue.

Please always check your issue with the latest Plugin and tha latest Maven version.

### Creating a Pull Request

Before you create a pull request it is necessary to create an issue in
Before you start working on more complicated change, new feature
it is good practice to create an issue in
the [ticket system](https://github.com/mojohaus/versions-maven-plugin/issues)
and describe what the problem is or what kind of feature you would like
to add. Afterwards you can create an appropriate pull request.
or send an emil to [development list](https://www.mojohaus.org/versions-maven-plugin/mailing-lists.html)
and describe what the problem is or what kind of feature you would like to add.
Wait a few days for feedback from other contributors.
Afterwards you can create an appropriate pull request.

It is required if you want to get a Pull request to be integrated into please
squash your commits into a single commit which references the issue in the
commit message which looks like this:
It is required if you want to get a pull request to be integrated into please
squash your commits into a single commit which references the optional issue
in the commit message which looks like this:

```
Fixed #Issue
o Description.
Fixed #Issue - change subject

a description
```

Please take consider that change subject will be used in release notes
and will be present in git history so should be enough descriptive.

This makes it simpler to merge it and this will also close the
appropriate issue automatically in one go. This make the life as
maintainer a little bit easier.
appropriate issue automatically in one go.
This make the life as maintainer a little bit easier.

A pull request has to fulfill only a single ticket and should never
create/add/fix several issues in one, cause otherwise the history is hard to
read and to understand and makes the maintenance of the issues and pull request
hard or to be honest impossible.


## Releasing

* Make sure `gpg-agent` is running.
Expand Down