[MNG-6362] - Adding CONTRIBUTING, README.md pull_request_template for GitHub.
Project: http://git-wip-us.apache.org/repos/asf/maven/repo Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/30cad065 Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/30cad065 Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/30cad065 Branch: refs/heads/MNG-6362 Commit: 30cad0657db4da42f710789d1db2ad9f668df2b9 Parents: 8f619ac Author: Karl Heinz Marbaise <khmarba...@apache.org> Authored: Sat Feb 17 13:52:01 2018 +0100 Committer: Karl Heinz Marbaise <khmarba...@apache.org> Committed: Mon Feb 19 23:27:44 2018 +0100 ---------------------------------------------------------------------- .github/pull_request_template.md | 30 ++++++++++ CONTRIBUTING.md | 80 ++++++++++++++++++++++++++ README.md | 104 +++++++++++++++++++++++++++++----- 3 files changed, 199 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven/blob/30cad065/.github/pull_request_template.md ---------------------------------------------------------------------- diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..2208cd7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ +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/MNG) 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 `[MNG-XXX] - Fixes bug in ApproximateQuantiles`, + where you replace `MNG-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 [Core IT][core-its] successfully. + +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). + +[core-its]: https://maven.apache.org/core-its/core-it-suite/ http://git-wip-us.apache.org/repos/asf/maven/blob/30cad065/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2720d7d --- /dev/null +++ b/CONTRIBUTING.md @@ -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 http://git-wip-us.apache.org/repos/asf/maven/blob/30cad065/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 33a4be4..d8f302b 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,97 @@ -# Maven +<!--- + 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 -Maven is available under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt) + http://www.apache.org/licenses/LICENSE-2.0 -- [Maven Issue Tracker](https://issues.apache.org/jira/browse/MNG) -- [Maven Wiki](https://cwiki.apache.org/confluence/display/MAVEN/Index) -- [Building Maven](https://maven.apache.org/guides/development/guide-building-maven.html) -- [Running Core ITs](https://maven.apache.org/core-its/core-it-suite/) + 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. +--> +Apache Maven +============ -## Bootstrapping Basics +[][license] +[](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apache.maven%22%20AND%20a%3A%22apache-maven%22) +[][build] +[][test-results] -If you want to bootstrap Maven, you'll need: -- Java 1.7+ -- Maven 3.0.5 or later +Apache Maven is a software project management and comprehension tool. Based on +the concept of a project object model (POM), Maven can manage a project's +build, reporting and documentation from a central piece of information. -Run Maven, specifying a location into which the completed Maven distro should be installed: +If you think you have found a bug please file in an issue into [Maven Issue Tracker](https://issues.apache.org/jira/browse/MNG) -``` -mvn -DdistributionTargetDir="$HOME/app/maven/apache-maven-3.5.x-SNAPSHOT" clean package -``` +Documentation +------------- -Once the build completes, you should have a new Maven distro ready to roll in that directory! +More information can be found on [Apache Maven Homepage][maven-home]. +Question related to the usage of the Maven should be posted on +the [Maven User List][users-list]. + +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 discus new ideas / features / bugs etc. + +[Maven Wiki](https://cwiki.apache.org/confluence/display/MAVEN/Index) +[Building Maven](https://maven.apache.org/guides/development/guide-building-maven.html) +[Running Core ITs](https://maven.apache.org/core-its/core-it-suite/) + + +Where can I get the latest release? +----------------------------------- +You can download release source from our [download page][maven-download]. + +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/Core IT 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/ +[license]: https://www.apache.org/licenses/LICENSE-2.0 +[build]: https://builds.apache.org/job/maven-wip/job/maven/job/master/ +[test-results]: https://builds.apache.org/job/maven-wip/job/maven/job/master/lastCompletedBuild/testReport/ +[build-status]: https://img.shields.io/jenkins/s/https/builds.apache.org/job/maven-wip/job/maven/job/master.svg?style=flat-square +[build-tests]: https://img.shields.io/jenkins/t/https/builds.apache.org/job/maven-wip/job/maven/job/master.svg?style=flat-square +[maven-home]: https://maven.apache.org/ +[maven-download]: https://maven.apache.org/download.cgi +[users-list]: http://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
