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 dd88a61 README improvement dd88a61 is described below commit dd88a61cd93f82288f1caf1c102f5b6a5ffb32a3 Author: Hervé Boutemy <hbout...@apache.org> AuthorDate: Mon Apr 13 22:22:24 2020 +0200 README improvement --- CONTRIBUTING.md | 109 -------------------------------------------------------- README.md | 6 ++-- 2 files changed, 3 insertions(+), 112 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 28f42f5..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,109 +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 JDeps Plugin -====================== - -[][license] -[][build] -[][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 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 [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](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's scope. -+ Submit a ticket for your issue or enhancement, 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][dev-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. -+ 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. - + 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. -``` -[MJDEPS-XXX] - Subject of the JIRA Ticket - 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. -+ 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]. - -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. - -Additional Resources --------------------- - -+ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch) -+ [Apache Maven Help JIRA project page](https://issues.apache.org/jira/projects/MSHARED/) -+ [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 - -[license]: https://www.apache.org/licenses/LICENSE-2.0 -[dev-ml-list]: http://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. diff --git a/README.md b/README.md index 2a53dfb..d31548e 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ Contributing to [Apache Maven JDeps Plugin](https://maven.apache.org/plugins/mav [][jira] [][license] -[](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apache.maven.plugins%22%20AND%20a%3A%22maven-jdeps-plugin%22) -[][build] -[][test-results] +[](https://search.maven.org/artifact/org.apache.maven.plugins/maven-jdeps-plugin) +[][build] +[][test-results] You have found a bug or you have an idea for a cool new feature? Contributing