khmarbaise commented on a change in pull request #1: [MJDEPS-Documentation] - Added readme.md for Apache Maven MJDEPS Plugin URL: https://github.com/apache/maven-jdeps-plugin/pull/1#discussion_r225659851
########## File path: readme.md ########## @@ -0,0 +1,107 @@ +<!--- +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 JDeps Plugin +====================== + +[][license] +[][build] +[][test-results] + + +Have you found a bug or had an idea for a cool new feature? Contributing +code is a great way to give something back to the open source community, learn from experts and widen your network. 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 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 or enhancement, 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 branch from where you want to base your work (this is usually the master branch). + Push your changes to a branch in your fork of the repository. ++ Make commits of logical units. ++ You can use version 9 of Java, but be aware that the code has target of version 6. ++ Respect the original code style: by using the same [codestyle][code-style], Review comment: Can you please check the current site of [maven-jdep-plugin](http://maven.apache.org/plugins/maven-jdeps-plugin/plugin-info.html) cause it's targeted JDK 7. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
