[MENFORCER-305] - Add documentation information for GitHub
authorKarl Heinz Marbaise <khmarbaise@apache.org>
Sat, 19 May 2018 07:40:28 +0000 (09:40 +0200)
committerKarl Heinz Marbaise <khmarbaise@apache.org>
Sun, 17 Jun 2018 16:37:55 +0000 (18:37 +0200)
.github/pull_request_template.md [new file with mode: 0644]
CONTRIBUTING.md [new file with mode: 0644]
README.TXT [deleted file]
README.md [new file with mode: 0644]

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644 (file)
index 0000000..c04497b
--- /dev/null
@@ -0,0 +1,28 @@
+Following this checklist to help us incorporate your 
+contribution quickly and easily:
+
+ - [ ] Make sure there is a [JIRA issue](https://issues.apache.org/jira/browse/MENFORCER) filed 
+       for the change (usually before you start working on it).  Trivial changes like typos do not 
+       require a JIRA issue.  Your pull request should address just this issue, without 
+       pulling in other changes.
+ - [ ] Each commit in the pull request should have a meaningful subject line and body.
+ - [ ] Format the pull request title like `[MENFORCER-XXX] - Fixes bug in ApproximateQuantiles`,
+       where you replace `MENFORCER-XXX` with the appropriate JIRA issue. Best practice
+       is to use the JIRA issue title in the pull request title and in the first line of the 
+       commit message.
+ - [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
+ - [ ] Run `mvn clean verify` to make sure basic checks pass. A more thorough check will 
+       be performed on your pull request automatically.
+
+If your pull request is about ~20 lines of code you don't need to sign an
+[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
+please ask on the developers list.
+
+To make clear that you license your contribution under 
+the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
+you have to acknowledge this by using the following check-box.
+
+ - [ ] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
+
+ - [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
+
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..2720d7d
--- /dev/null
@@ -0,0 +1,80 @@
+<!---
+ 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 [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 you're 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.
++ 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 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 ticket in JIRA.  In this case, it is appropriate to
+start the first line of a commit with '(doc)' instead of a ticket 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.
++ Update your JIRA ticket and include a link to the pull request in the ticket.
+
+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.TXT b/README.TXT
deleted file mode 100644 (file)
index 71e0c62..0000000
+++ /dev/null
@@ -1,24 +0,0 @@
-Deploying web site
--------------------
-You can use the deploySite(.sh|.bat) script
-Without any profile, the site will be deployed to http://maven.apache.org/enforcer-archives/enforcer-${project.version}
-sh ./deploySite.sh -Preporting
-
-To deploy main version http://maven.apache.org/enforcer, use
-sh ./deploySite.sh -Preporting -Psite-release
-
-Note you can add arguments to the script to pass your svn credentials:
--Dusername=
--Dpassword=
-
-Workflow for site when releasing
---------------------------------
-Once release staged, you can publish a staged site.
-cd target/checkout
-sh ./deploySite.sh -Preporting
-content will be in http://maven.apache.org/enforcer-archives/enforcer-${project.version}
-
-Once vote passed, redeploy main site:
-cd target/checkout (or use the version tag)
-sh ./deploySite.sh -Preporting -Psite-release
-
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..1583893
--- /dev/null
+++ b/README.md
@@ -0,0 +1,96 @@
+<!---
+ 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.
+-->
+Maven Enforcer Plugin - The Loving Iron Fist of Maven™
+======================================================
+
+[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven-enforcer.svg?label=License)][license]
+[![Maven Central](https://img.shields.io/maven-central/v/org.apache.maven.plugins/maven-enforcer-plugin.svg?label=Maven%20Central)](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.maven.plugins%22%20a%3A%22maven-enforcer-plugin%22)
+[![Jenkins Status](https://img.shields.io/jenkins/s/https/builds.apache.org/job/maven-box/job/maven-enforcer/job/master.svg?style=flat-square)][build]
+[![Jenkins tests](https://img.shields.io/jenkins/t/https/builds.apache.org/job/maven-box/job/maven-enforcer/job/master.svg?style=flat-square)][test-results]
+
+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].
+
+You can get the Maven Enforcer plugin via the following coordinates from central:
+
+```xml
+<plugin>
+  <groupId>org.apache.maven.plugins</groupId>
+  <artifactId>maven-enforcer-plugin</artifactId>
+  <version>3.0.0-M1</version>
+</plugin>
+```
+
+Contributing
+------------
+
+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:
++ 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]
+
+
+[home]: https://maven.apache.org/enforcer/maven-enforcer-plugin
+[license]: https://www.apache.org/licenses/LICENSE-2.0
+[build]: https://builds.apache.org/job/maven-box/job/maven-enforcer/
+[test-results]: https://builds.apache.org/job/maven-box/job/maven-enforcer/job/master/lastCompletedBuild/testReport/
+[build-status]: https://img.shields.io/jenkins/s/https/builds.apache.org/job/maven-box/job/maven-enforcer/job/master.svg?style=flat-square
+[build-tests]: https://img.shields.io/jenkins/t/https/builds.apache.org/job/maven-box/job/maven-enforcer/job/master.svg?style=flat-square
+[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/mail-lists.html
+[dev-ml-list]: https://www.mail-archive.com/dev@maven.apache.org/
+[code-style]: https://maven.apache.org/developers/conventions/code.html