This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-enforcer.git
The following commit(s) were added to refs/heads/master by this push:
new fec424a8 Move contributing information into README
fec424a8 is described below
commit fec424a87ca5cd5262216f249db67cf8f75c6e80
Author: Slawomir Jaranowski <s.jaranow...@gmail.com>
AuthorDate: Fri Jul 11 21:47:28 2025 +0200
Move contributing information into README
In the most Maven project we have such information in README,
so to be consistent move it also here.
Use a similar format as in another project.
---
CONTRIBUTING.md | 81 ------------------------------------------------
README.md | 96 ++++++++++++++++++++++++++++-----------------------------
2 files changed, 48 insertions(+), 129 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
deleted file mode 100644
index b442a428..00000000
--- a/CONTRIBUTING.md
+++ /dev/null
@@ -1,81 +0,0 @@
-<!---
- 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.
--->
-Contributing to Apache Maven Enforcer
-======================
-
-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.
-
-Getting Started
----------------
-
-+ 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](https://maven.apache.org/mail-lists.html) first.
- This way you can make sure you're not wasting your time on something that
isn't
- considered to be in Apache Maven Enforcer's scope.
-+ Open a GitHub issue for the issue, assuming one does not already exist.
- + Clearly describe the issue. If it is a bug, include steps to reproduce it.
- + Make sure you fill in the earliest version that you know has the issue.
-+ Fork the repository on GitHub.
-
-Making Changes
---------------
-
-+ Create a topic branch from where you want to base your work (this is usually
the master branch).
-+ Make commits of logical units.
-+ Respect the original code style:
- + 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.
-+ Make sure you have added the necessary tests for your changes.
-+ Run all the tests with `mvn -Prun-its clean verify` to assure nothing else
was accidentally broken.
-
-Making Trivial Changes
-----------------------
-
-For changes of a trivial nature to comments and documentation, it is not always
-necessary to create a new issue. In this case, it is appropriate to
-start the first line of a commit with '(doc)' instead of an issue number.
-
-Submitting Changes
-------------------
-
-+ Sign the [Contributor License Agreement][cla] if you haven't already.
-+ Push your changes to a topic branch in your fork of the repository.
-+ Submit a pull request to the repository in the apache organization.
-+ Include the issue number in the PR description as "#234" if there's more
work
- to be done on the issue following this PR, or "fixes #234" if the PR
completes work
- on the issue.
-
-Additional Resources
---------------------
-
-+ [Contributing
patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
-+ [Apache Maven Enforcer JIRA project
page](https://issues.apache.org/jira/projects/MENFORCER/)
-+ [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
-
-[cla]:https://www.apache.org/licenses/#clas
diff --git a/README.md b/README.md
index fe7a3ab7..651b5135 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-Maven Enforcer Plugin - The Loving Iron Fist of Maven™
+Contributing to [Maven Enforcer - The Loving Iron Fist of
Maven™](https://maven.apache.org/enforcer/maven-enforcer-plugin)
======================================================
[][license]
@@ -27,57 +27,57 @@ The Enforcer plugin provides goals to control certain
environmental constraints
such as Maven version, JDK version and OS family along with many more built-in
rules and user created rules.
-Documentation
--------------
-
-More information can be found on [Apache Maven Enforcer Plugin
Homepage][enforcer-home].
-Question related to the usage of the Maven Enforcer Plugin should be posted on
-the [Maven User List][users-list].
-
-Where can I get the latest release?
------------------------------------
-You can download release source from our [download page][enforcer-download].
-
-Contributing
-------------
-
-We accept Pull Requests via GitHub. The [developer mailing list][dev-ml-list]
is the
+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.
+
+Getting Started
+---------------
+
++ 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.
+ This way you can make sure you're not wasting your time on something that
isn't
+ considered to be in Apache Maven's scope.
++ Submit a ticket for your issue, assuming one does not already exist.
+ + Clearly describe the issue, including steps to reproduce when it is a bug.
+ + Make sure you fill in the earliest version that you know has the issue.
++ Fork the repository on GitHub.
+
+Making and Submitting Changes
+--------------
+
+We accept Pull Requests via GitHub. The [developer mailing list][ml-list] is
the
main channel of communication for contributors.
There are some guidelines which will make applying PRs easier for us:
-+ No tabs! Please use spaces for indentation.
-+ Respect the [code style][code-style].
-+ 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.
-+ Provide JUnit/Invoker tests for your changes and make sure your changes
don't break
- any existing tests by running ```mvn -Prun-its verify```.
-
-If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement](https://www.apache.org/licenses/#clas).
-You can learn more about contributing via GitHub in our [contribution
guidelines](CONTRIBUTING.md).
-
-
-License
--------
-This code is under the [Apache Licence v2][license]
-
-See the `NOTICE` file for required notices and attributions.
-
-Donations
----------
-You like Apache Maven? Then [donate back to the
ASF](https://www.apache.org/foundation/contributing.html) to support the
development.
-
-License
--------
-[Apache License, Version 2.0, January 2004][license]
++ 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][code-style],
+ 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 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.
++ Submit a pull request to the repository in the Apache organization.
+
+If you plan to contribute on a regular basis, please consider filing a
[contributor license agreement][cla].
+
+Additional Resources
+--------------------
+
++ [Contributing
patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
++ [Contributor License Agreement][cla]
++ [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/@asfmavenproj...@fosstodon.org)
-[home]: https://maven.apache.org/enforcer/maven-enforcer-plugin
[license]: https://www.apache.org/licenses/LICENSE-2.0
[build]:
https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/
[test-results]:
https://ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/job/master/lastCompletedBuild/testReport/
-[build-status]:
https://img.shields.io/jenkins/s/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/job/master.svg?
-[build-tests]:
https://img.shields.io/jenkins/t/https/ci-maven.apache.org/job/Maven/job/maven-box/job/maven-enforcer/job/master.svg?
-[enforcer-home]: https://maven.apache.org/enforcer/maven-enforcer-plugin/
-[enforcer-download]: https://maven.apache.org/enforcer/download.cgi
-[users-list]: https://maven.apache.org/mailing-lists.html
-[dev-ml-list]: https://www.mail-archive.com/dev@maven.apache.org/
+[ml-list]: https://maven.apache.org/mailing-lists.html
[code-style]: https://maven.apache.org/developers/conventions/code.html
