Sebastian Nagel created NUTCH-3179:
--------------------------------------
Summary: Add CONTRIBUTING.MD to the Nutch code repository
Key: NUTCH-3179
URL: https://issues.apache.org/jira/browse/NUTCH-3179
Project: Nutch
Issue Type: Improvement
Components: documentation
Affects Versions: 1.23
Reporter: Sebastian Nagel
Fix For: 1.23
The [CONTRIBUTING.md|https://contributing.md/example/] ([GitHub's
docs|https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors])
is a common standard to share instructions how contributions to the project
should like.
Nutch currently provides instructions on
1. the [GitHub PR
template|https://github.com/apache/nutch/blob/master/.github/pull_request_template.md]
2. in the Wiki, mostly [Becoming A Nutch
Developer|https://cwiki.apache.org/confluence/display/NUTCH/Becoming+A+Nutch+Developer].
The CONTRIBUTING.md should include the most important points from both sources.
We might review the requirements and reduce the demands, for example, allow
GitHub pull requests without Jira issues. In doubt, Nutch committers can create
the Jira issues afterwards before merging the PR and note/link the NUTCH-XXXX
Jira issue in the merge commit.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
