|
| 1 | +<!--- |
| 2 | + Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + contributor license agreements. See the NOTICE file distributed with |
| 4 | + this work for additional information regarding copyright ownership. |
| 5 | + The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + (the "License"); you may not use this file except in compliance with |
| 7 | + the License. You may obtain a copy of the License at |
| 8 | +
|
| 9 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | + Unless required by applicable law or agreed to in writing, software |
| 12 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + See the License for the specific language governing permissions and |
| 15 | + limitations under the License. |
| 16 | +--> |
| 17 | +Contributing to [Apache Maven Verifier](https://maven.apache.org/shared/maven-verifier/) |
| 18 | +====================== |
| 19 | + |
| 20 | +[][jira] |
| 21 | +[][license] |
| 22 | +[](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.apache.maven.shared%22%20AND%20a%3A%22maven-verifier%22) |
| 23 | +[][build] |
| 24 | +[][test-results] |
| 25 | + |
| 26 | + |
| 27 | +You have found a bug or you have an idea for a cool new feature? Contributing |
| 28 | +code is a great way to give something back to the open source community. Before |
| 29 | +you dig right into the code, there are a few guidelines that we need |
| 30 | +contributors to follow so that we can have a chance of keeping on top of |
| 31 | +things. |
| 32 | + |
| 33 | +Getting Started |
| 34 | +--------------- |
| 35 | + |
| 36 | ++ Make sure you have a [JIRA account](https://issues.apache.org/jira/). |
| 37 | ++ Make sure you have a [GitHub account](https://github.com/signup/free). |
| 38 | ++ If you're planning to implement a new feature, it makes sense to discuss your changes |
| 39 | + on the [dev list][ml-list] first. |
| 40 | + This way you can make sure you're not wasting your time on something that isn't |
| 41 | + considered to be in Apache Maven's scope. |
| 42 | ++ Submit a ticket for your issue, assuming one does not already exist. |
| 43 | + + Clearly describe the issue, including steps to reproduce when it is a bug. |
| 44 | + + Make sure you fill in the earliest version that you know has the issue. |
| 45 | ++ Fork the repository on GitHub. |
| 46 | + |
| 47 | +Making and Submitting Changes |
| 48 | +-------------- |
| 49 | + |
| 50 | +We accept Pull Requests via GitHub. The [developer mailing list][ml-list] is the |
| 51 | +main channel of communication for contributors. |
| 52 | +There are some guidelines which will make applying PRs easier for us: |
| 53 | ++ Create a topic branch from where you want to base your work (this is usually the master branch). |
| 54 | + Push your changes to a topic branch in your fork of the repository. |
| 55 | ++ Make commits of logical units. |
| 56 | ++ Respect the original code style: by using the same [codestyle][code-style], |
| 57 | + patches should only highlight the actual difference, not being disturbed by any formatting issues: |
| 58 | + + Only use spaces for indentation. |
| 59 | + + Create minimal diffs - disable on save actions like reformat source code or organize imports. |
| 60 | + If you feel the source code should be reformatted, create a separate PR for this change. |
| 61 | + + Check for unnecessary whitespace with `git diff --check` before committing. |
| 62 | ++ Make sure your commit messages are in the proper format. Your commit message should contain the key of the JIRA issue. |
| 63 | +``` |
| 64 | +[MSHARED-XXX] - Subject of the JIRA Ticket |
| 65 | + Optional supplemental description. |
| 66 | +``` |
| 67 | ++ Make sure you have added the necessary tests (JUnit/IT) for your changes. |
| 68 | ++ Run all the tests with `mvn -Prun-its verify` to assure nothing else was accidentally broken. |
| 69 | ++ Submit a pull request to the repository in the Apache organization. |
| 70 | ++ Update your JIRA ticket and include a link to the pull request in the ticket. |
| 71 | + |
| 72 | +If you plan to contribute on a regular basis, please consider filing a [contributor license agreement][cla]. |
| 73 | + |
| 74 | +Making Trivial Changes |
| 75 | +---------------------- |
| 76 | + |
| 77 | +For changes of a trivial nature to comments and documentation, it is not always |
| 78 | +necessary to create a new ticket in JIRA. In this case, it is appropriate to |
| 79 | +start the first line of a commit with '(doc)' instead of a ticket number. |
| 80 | + |
| 81 | +Additional Resources |
| 82 | +-------------------- |
| 83 | + |
| 84 | ++ [Contributing patches](https://maven.apache.org/guides/development/guide-maven-development.html#Creating_and_submitting_a_patch) |
| 85 | ++ [Apache Maven Shared Components project page][jira] |
| 86 | ++ [Contributor License Agreement][cla] |
| 87 | ++ [General GitHub documentation](https://help.github.com/) |
| 88 | ++ [GitHub pull request documentation](https://help.github.com/send-pull-requests/) |
| 89 | ++ [Apache Maven Twitter Account](https://twitter.com/ASFMavenProject) |
| 90 | ++ #Maven IRC channel on freenode.org |
| 91 | + |
| 92 | +[jira]: https://issues.apache.org/jira/projects/MSHARED/ |
| 93 | +[license]: https://www.apache.org/licenses/LICENSE-2.0 |
| 94 | +[ml-list]: https://maven.apache.org/mailing-lists.html |
| 95 | +[code-style]: https://maven.apache.org/developers/conventions/code.html |
| 96 | +[cla]: https://www.apache.org/licenses/#clas |
| 97 | +[maven-wiki]: https://cwiki.apache.org/confluence/display/MAVEN/Index |
| 98 | +[test-results]: https://builds.apache.org/job/maven-box/job/maven-verifier/job/master/lastCompletedBuild/testReport/ |
| 99 | +[build]: https://builds.apache.org/job/maven-box/job/maven-verifier/job/master/ |
0 commit comments