[NUTCH-2500] Add pull-reqest template to github

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Component/s: documentation
• Assignee: Sebastian Nagel
• Reporter: Sebastian Nagel
• Created: 17/Jan/18 11:03
• Updated: 28/Jan/21 14:04
• Resolved: 24/May/18 12:36

Description

Github allows to add [pull request templates](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/). For contributors already familiar with github from other projects that's probably the best place to show a check list which helps us to get pull requests merged more quickly. Here's a draft:

Thanks for your contribution to [Apache Nutch](http://nutch.apache.org/)! Your help is appreciated!

Before opening the pull request, please verify that
* there is an open issue on the [Nutch issue tracker](https://issues.apache.org/jira/projects/NUTCH) which describes the problem or the improvement. We cannot accept pull requests without an issue because the change wouldn't be listed in the release notes.
* the issue ID (`NUTCH-XXXX`)
  - is referenced in the title of the pull request
  - and placed in front of your commit messages
* commits are squashed into a single one (or few commits for larger changes)
* Java source code follows [Nutch Eclipse Code Formatting rules](https://github.com/apache/nutch/blob/master/eclipse-codeformat.xml)
* Nutch builds and unit tests pass by running `ant clean runtime test`

Issue Links

• links to: GitHub Pull Request #333