You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2018/04/01 16:30:48 UTC
[maven-javadoc-plugin] branch MJAVADOC-521 updated: WIP -
MJAVADOC-521
This is an automated email from the ASF dual-hosted git repository.
khmarbaise pushed a commit to branch MJAVADOC-521
in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
The following commit(s) were added to refs/heads/MJAVADOC-521 by this push:
new bfda8c9 WIP - MJAVADOC-521
bfda8c9 is described below
commit bfda8c93c88db97d87356565392e88ba874e0335
Author: Karl Heinz Marbaise <kh...@apache.org>
AuthorDate: Sun Apr 1 18:30:33 2018 +0200
WIP - MJAVADOC-521
---
.checkstyle | 13 ++++++
README.md | 138 +++++++++++++++++++++++++++++++++---------------------------
2 files changed, 90 insertions(+), 61 deletions(-)
diff --git a/.checkstyle b/.checkstyle
new file mode 100644
index 0000000..169d885
--- /dev/null
+++ b/.checkstyle
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<fileset-config file-format-version="1.2.0" simple-config="false" sync-formatter="false">
+ <local-check-config name="maven-checkstyle-plugin checkstyle-check" location="jar:file:/Users/kama/.m2/repository/org/apache/maven/shared/maven-shared-resources/2/maven-shared-resources-2.jar!/config/maven_checks.xml" type="remote" description="maven-checkstyle-plugin configuration checkstyle-check">
+ <property name="checkstyle.cache.file" value="${project_loc}/target/checkstyle-cachefile"/>
+ <property name="checkstyle.header.file" value="/Users/kama/eclipse-workspace/.metadata/.plugins/org.eclipse.core.resources/.projects/maven-javadoc-plugin/com.basistech.m2e.code.quality.checkstyleConfigurator/checkstyle-header-checkstyle-check.txt"/>
+ </local-check-config>
+ <fileset name="java-sources-checkstyle-check" enabled="true" check-config-name="maven-checkstyle-plugin checkstyle-check" local="true">
+ <file-match-pattern match-pattern="^src/main/java.*\.java" include-pattern="true"/>
+ <file-match-pattern match-pattern="^src/main/resources/.*\.properties" include-pattern="true"/>
+ <file-match-pattern match-pattern="^src/test/resources/.*\.properties" include-pattern="true"/>
+ </fileset>
+</fileset-config>
diff --git a/README.md b/README.md
index d5e9dc7..fa7fa11 100644
--- a/README.md
+++ b/README.md
@@ -14,68 +14,84 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-Apache Maven
-============
+Contributing to Apache Maven JavaDoc Plugin
+======================
[][license]
[](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apache.maven.plugins%22%20AND%20a%3A%22maven-javadoc-plugin%22)
-[][build]
-[][test-results]
-
-
-The Javadoc Plugin uses the Javadoc tool to generate javadocs for the specified
-project. For more information about the standard Javadoc tool, please refer to
-[Reference Guide](http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html).
-
-If you think you have found a bug, please file in an issue into [Maven Issue Tracker](https://issues.apache.org/jira/browse/MJAVADOC)
-
-Documentation
--------------
-
-More information can be found on [Apache Maven JavaDoc Plugin Homepage][maven-home].
-Question related to the usage of the Maven JavaDoc 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][maven-download].
-
-Contributing
-------------
-
-If you are interested in the development of Maven, please consult the
-documentation first and afterwards you are welcome to join the developers
-mailing list to ask question or discuss new ideas / features / bugs etc.
-
-Take a look into the [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]
-
-
-[license]: https://www.apache.org/licenses/LICENSE-2.0
-[build]: https://builds.apache.org/job/maven-box/job/maven-javadoc-plugin/job/master/
-[test-results]: https://builds.apache.org/job/maven-box/job/maven-javadoc-plugin/job/master/lastCompletedBuild/testReport/
-[build-status]: https://img.shields.io/jenkins/s/https/builds.apache.org/job/maven-box/job/maven-javadoc-plugin/job/master.svg?style=flat-square
-[build-tests]: https://img.shields.io/jenkins/t/https/builds.apache.org/job/maven-box/job/maven-javadoc-plugin/job/master.svg?style=flat-square
-[maven-home]: https://maven.apache.org/plugins/maven-javadoc-plugin/
-[maven-download]: https://maven.apache.org/plugins/maven-javadoc-plugin/download.cgi
-[users-list]: https://maven.apache.org/mail-lists.html
-[dev-ml-list]: https://www.mail-archive.com/dev@maven.apache.org/
-[code-style]: http://maven.apache.org/developers/conventions/code.html
-[core-it]: https://maven.apache.org/core-its/core-it-suite/
-[building-maven]: https://maven.apache.org/guides/development/guide-building-maven.html
+[][build]
+[][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
+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.
+
+Some of the ideas are documented in the [Maven Wiki][maven-wiki]
+which might be interesting to read and for further discussion.
+
+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, 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 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 your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue.
+```
+[MJAVADOC-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 -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].
+
+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 JavaDoc JIRA project page](https://issues.apache.org/jira/projects/MJAVADOC/)
++ [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
+
+[dev-ml-list]: https://maven.apache.org/mail-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-javadoc-plugin/job/master/lastCompletedBuild/testReport/
--
To stop receiving notification emails like this one, please contact
khmarbaise@apache.org.