diff --git a/README.md b/README.md index 9a9c0e0..b8e4323 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,12 @@ Contributing to [Apache Maven Plugin Testing](https://maven.apache.org/plugin-testing/) ====================== -[![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MPLUGINTESTING.json)][jira] [![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license] -[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugin-testing/maven-plugin-testing.svg?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.maven.plugin-testing/maven-plugin-testing) -[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/master.svg)][build] -[![Jenkins tests](https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/master.svg)][test-results] - +[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugin-testing/maven-plugin-testing-harness?filter=3.*&label=Maven%20Central +)](https://search.maven.org/artifact/org.apache.maven.plugin-testing/maven-plugin-testing) +[![Reproducible Builds](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jvm-repo-rebuild/reproducible-central/master/content/org/apache/maven/plugin-testing/maven-plugin-testing/badge.json)](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/apache/maven/plugin-testing/maven-plugin-testing/README.md) +[![Jenkins Status](https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/maven-plugin-testing-3.x.svg)][build] +[![Jenkins tests](https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/maven-plugin-testing-3.x.svg)][test-results] 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 @@ -33,7 +33,6 @@ things. Getting Started --------------- -+ Make sure you have a [JIRA account](https://issues.apache.org/jira/). + Make sure you have a [GitHub account](https://github.com/signup/free). + If you're planning to implement a new feature, it makes sense to discuss your changes on the [dev list][ml-list] first. @@ -59,41 +58,34 @@ There are some guidelines which will make applying PRs easier for us: + 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. -``` -[MPLUGINTESTING-XXX] - Subject of the JIRA Ticket - Optional supplemental description. -``` ++ Make sure your commit messages are in the proper format. + Make sure you have added the necessary tests (JUnit/IT) for your changes. -+ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken. ++ Run all the tests with `mvn verify` to assure nothing else was accidentally broken. + Submit a pull request to the repository in the Apache organization. -+ Update your JIRA ticket and include a link to the pull request in the ticket. If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla]. 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. +For changes of a trivial nature to comments and documentation, or other simple changes +it is not always necessary to create a new issue. +In this case, it is appropriate to skip the issue from a commit message. Additional Resources -------------------- + [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch) -+ [Apache Maven maven-plugin-testing JIRA project page][jira] + [Contributor License Agreement][cla] -+ [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) -+ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject) -+ #Maven IRC channel on freenode.org ++ [General GitHub documentation](https://docs.github.com/) ++ [GitHub pull request documentation](https://docs.github.com/pull-requests) ++ [Apache Maven X Account](https://x.com/ASFMavenProject) ++ [Apache Maven Bluesky Account](https://bsky.app/profile/maven.apache.org) ++ [Apache Maven Mastodon Account](https://mastodon.social/deck/@ASFMavenProject@fosstodon.org) -[jira]: https://issues.apache.org/jira/projects/MPLUGINTESTING/ [license]: https://www.apache.org/licenses/LICENSE-2.0 [ml-list]: https://maven.apache.org/mailing-lists.html [code-style]: https://maven.apache.org/developers/conventions/code.html [cla]: https://www.apache.org/licenses/#clas -[maven-wiki]: https://cwiki.apache.org/confluence/display/MAVEN/Index -[test-results]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/master/lastCompletedBuild/testReport/ -[build]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/master/ +[test-results]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/maven-plugin-testing-3.x/lastCompletedBuild/testReport/ +[build]: https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-plugin-testing/job/maven-plugin-testing-3.x/