[maven-jar-plugin] 01/01: [MJAR-251] - Add documentation information for GitHub

[khmarbaise]

This is an automated email from the ASF dual-hosted git repository.

khmarbaise pushed a commit to branch MJAR-251
in repository https://gitbox.apache.org/repos/asf/maven-jar-plugin.git

commit 4929dc1fbf0d0c078bace9847cc0dbcffa9ba146
Author: Karl Heinz Marbaise 
AuthorDate: Sat Apr 14 21:31:52 2018 +0200

[MJAR-251] - Add documentation information for GitHub
---
 .github/pull_request_template.md | 29 
 CONTRIBUTING.md  | 91 +
 README.md| 97 
 3 files changed, 217 insertions(+)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000..c94da7b
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,29 @@
+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/MJAR) 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 `[MJAR-XXX] - Fixes bug in 
ApproximateQuantiles`,
+   where you replace `MJAR-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.
+ - [ ] You have run the integration tests successfully (`mvn -Prun-its clean 
verify`).
+
+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
index 000..23dc884
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,91 @@
+
+Contributing to Apache Maven Jar Plugin
+==
+
+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 

[maven-jar-plugin] 01/01: [MJAR-251] - Add documentation information for GitHub

[khmarbaise]

This is an automated email from the ASF dual-hosted git repository.

khmarbaise pushed a commit to branch MJAR-251
in repository https://gitbox.apache.org/repos/asf/maven-jar-plugin.git

commit fbf038d69d431e42057f882a049ddeeddfb00c0a
Author: Karl Heinz Marbaise 
AuthorDate: Sat Apr 14 21:31:52 2018 +0200

[MJAR-251] - Add documentation information for GitHub
---
 .github/pull_request_template.md | 29 
 CONTRIBUTING.md  | 91 +
 README.md| 97 
 3 files changed, 217 insertions(+)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000..c94da7b
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,29 @@
+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/MJAR) 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 `[MJAR-XXX] - Fixes bug in 
ApproximateQuantiles`,
+   where you replace `MJAR-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.
+ - [ ] You have run the integration tests successfully (`mvn -Prun-its clean 
verify`).
+
+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
index 000..23dc884
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,91 @@
+
+Contributing to Apache Maven Jar Plugin
+==
+
+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