diff options
| author | Roman Ivanov <ivanov-jr@mail.ru> | 2016-06-23 20:57:09 -0700 |
|---|---|---|
| committer | Roman Ivanov <ivanov-jr@mail.ru> | 2016-06-23 20:57:09 -0700 |
| commit | d11a606888aa7799d3a28ad0ccaa85faa7eba220 (patch) | |
| tree | feb8061f50b539fcf2a6657602a5b5a52235a9c8 /.github | |
| parent | df9e190c52a706dba9bd5bb86a39285e160d2063 (diff) | |
| download | checkstyle-d11a606888aa7799d3a28ad0ccaa85faa7eba220.tar.gz | |
config: introduction of CONTRIBUTING.md, ISSUE_TEMPLATE.md, and PULL_REQUEST_TEMPLATE.md files
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 6 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 20 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 15 |
3 files changed, 38 insertions, 3 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b649a9bf8..e448a0563 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1 +1,5 @@ -some text
\ No newline at end of file +Please read http://checkstyle.sourceforge.net/report_issue.html + +Please provide issue report in format that we request, EACH DETAIL MAKE A HUGE HELP. + +Issues that are not following the guidelines, will be processed with last priority.
\ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index b649a9bf8..bf7b7c706 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1 +1,19 @@ -some text
\ No newline at end of file +/var/tmp $ javac YOUR_FILE.java +[[PLACE YOU OUTPUT HERE]] + +/var/tmp $ cat YOUR_FILE.java +[[PLACE YOU OUTPUT HERE]] + +/var/tmp $ cat config.xml +[[PLACE YOU OUTPUT HERE]] + +/var/tmp $ java -jar checkstyle-X.XX-all.jar -c config.xml YOUR_FILE.java +[[PLACE YOU OUTPUT HERE]] + +--------------- + +Describe what you expect in details. + +-------------- + +Still not clear ??? - see example - http://checkstyle.sourceforge.net/report_issue.html#How_to_report_a_bug
\ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b649a9bf8..5ac364692 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1 +1,14 @@ -some text
\ No newline at end of file +Mandatory: +0) Issue you are tryining to fix/resolve has to have "approved" label. +1) Put in description of Pull Request reference to issue if it exists. Example: "Issue: #XXXXXX" +2) Proper commit message should adhere to the following rules: + a) Must match one of the following patterns:\n" + ^Issue #\\d+: .*$ + ^Pull #\\d+: .*$ + ^(minor|config|infra|doc|spelling): .*$ + b) It contains only one line of text + c) Must not end with a period, space, or tab + +To avoid multiple iterations of fixes and CIs failures, please read http://checkstyle.sourceforge.net/contributing.html + +ATTENTION: We are not merging Pull Requests that not passing your CIs.
\ No newline at end of file |