You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2020/04/13 08:30:07 UTC
[maven-jdeps-plugin] branch master updated: added README
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-jdeps-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new ff416cb added README
ff416cb is described below
commit ff416cb3954232d0b755b279714137371c946720
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon Apr 13 10:30:03 2020 +0200
added README
---
.asf.yaml | 26 ++++++++++++++++++++++++++
README.md | 58 ++++++++++++++++++++++++----------------------------------
2 files changed, 50 insertions(+), 34 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 0000000..6a14474
--- /dev/null
+++ b/.asf.yaml
@@ -0,0 +1,26 @@
+#
+# 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.
+#
+# see https://s.apache.org/asfyaml
+github:
+ description: "Apache Maven JDeps Plugin"
+ homepage: https://maven.apache.org/plugins/maven-jdeps-plugin/
+ labels:
+ - java
+ - build-management
+ - maven-plugins
+ - maven-jdeps-plugin
+ - maven
diff --git a/README.md b/README.md
index d32d1c2..2a53dfb 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,31 @@
<!---
-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.
+ 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 JDeps Plugin](https://maven.apache.org/plugins/maven-jdeps-plugin/)
======================
[![ASF Jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fmaven.apache.org%2Fbadges%2Fasf_jira-MJDEPS.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.plugins/maven-jdeps-plugin.svg?label=Maven%20Central)](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apache.maven.plugins%22%20AND%20a%3A%22maven-jdeps-plugin%22)
[![Jenkins Status](https://img.shields.io/jenkins/s/https/builds.apache.org/job/maven-box/job/maven-jdeps-plugin/job/master.svg?style=flat-square)][build]
[![Jenkins tests](https://img.shields.io/jenkins/t/https/builds.apache.org/job/maven-box/job/maven-jdeps-plugin/job/master.svg?style=flat-square)][test-results]
-Have you found a bug or had an idea for a cool new feature? Contributing
-code is a great way to give something back to the open source community, learn from experts and widen your network. Before
+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.
@@ -41,7 +39,7 @@ Getting Started
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 or enhancement, assuming one does not already exist.
++ 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.
@@ -52,10 +50,9 @@ 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:
-+ Create a branch from where you want to base your work (this is usually the master branch).
- Push your changes to a branch in your fork of the repository.
++ 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.
-+ You can use version 9 of Java, but be aware that the code has target of version 7
+ 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.
@@ -68,8 +65,9 @@ There are some guidelines which will make applying PRs easier for us:
Optional supplemental description.
```
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
-+ Run all the tests with `mvn test` to assure nothing else was accidentally broken.
++ 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.
++ 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].
@@ -84,7 +82,7 @@ Additional Resources
--------------------
+ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch)
-+ [Apache Maven JDeps Plugin JIRA project page][jira]
++ [Apache Maven JDeps 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/)
@@ -93,17 +91,9 @@ Additional Resources
[jira]: https://issues.apache.org/jira/projects/MJDEPS/
[license]: https://www.apache.org/licenses/LICENSE-2.0
-[ml-list]: http://maven.apache.org/mailing-lists.html
+[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://builds.apache.org/job/maven-box/job/maven-jdeps-plugin/job/master/lastCompletedBuild/testReport/
[build]: https://builds.apache.org/job/maven-box/job/maven-jdeps-plugin/job/master/
-
-
-Testing
---------------------
-
-Integration projects for plugins are placed under src/it/MJDEPS-XXX_shortDescription.
-The integration tests are run from the command line using `mvn verify -Prun-its`
-To verify the outcome, write a groovyscript following verify.groovy.