added README
diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 0000000..7bbf742
--- /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 JXR (Plugin)"
+ homepage: https://maven.apache.org/jxr/
+ labels:
+ - java
+ - build-management
+ - maven-plugins
+ - maven-jxr-plugin
+ - maven
diff --git a/README b/README
deleted file mode 100644
index f14f108..0000000
--- a/README
+++ /dev/null
@@ -1,6 +0,0 @@
-Maven JXR
-=========
-
-http://maven.apache.org/jxr/
-
-Developers list: dev@maven.apache.org
diff --git a/README.md b/README.md
index cbe7998..e4cc3f3 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.
-->
-Contributing to [Apache Maven JXR Plugin](https://maven.apache.org/jxr/maven-jxr-plugin/)
+Contributing to [Apache Maven JXR (Plugin)](https://maven.apache.org/jxr/)
======================
[][jira]
@@ -61,7 +61,7 @@
+ 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.
```
-[JXR-XXX] Subject of the JIRA Ticket
+[JXR-XXX] - Subject of the JIRA Ticket
Optional supplemental description.
```
+ Make sure you have added the necessary tests (JUnit/IT) for your changes.
@@ -91,9 +91,9 @@
[jira]: https://issues.apache.org/jira/projects/JXR/
[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-jxr/job/master/lastCompletedBuild/testReport/
-[build]: https://builds.apache.org/job/maven-box/job/maven-jxr/job/master/
+[test-results]: https://builds.apache.org/job/maven-box/job/maven-jxr-plugin/job/master/lastCompletedBuild/testReport/
+[build]: https://builds.apache.org/job/maven-box/job/maven-jxr-plugin/job/master/
