-
Notifications
You must be signed in to change notification settings - Fork 48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update contributing #121
Update contributing #121
Conversation
* master: (144 commits) Fix typo Modify travis.yml according to https://github.com/randy3k/UnitTesting-example/blob/master/.travis.yml Recover sudo Change url Remove 'sudo' Sudo-enabled Trusty images Rename and modify message format Preparation for v2.7.1 Allow single quoted value Fix string replacement Regex matching setting tags fixed Dropped dependency on bs4 sucrificing tag-defined id_replacements Update messages.json - Update change logs - Add message Add 'Link Prefix' on README Specify codeblock syntax Use double quote in string value Fix error Add link_prefix test Add 'link_prefix' ...
Codecov Report
@@ Coverage Diff @@
## master #121 +/- ##
==========================================
+ Coverage 93.25% 95.16% +1.91%
==========================================
Files 1 1
Lines 326 455 +129
==========================================
+ Hits 304 433 +129
Misses 22 22
Continue to review full report at Codecov.
|
I will have a look ASAP. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @naokazuterada, here are some suggestions for minor improvements to the language. Please pick the ones you like if any.
.github/CONTRIBUTING.md
Outdated
@@ -4,12 +4,24 @@ These are the guidelines for contributing to this repository. | |||
|
|||
## Issues | |||
|
|||
File an issue if you think you've found a bug. Please describe | |||
Please follow the each template by the type of your issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Please follow the each template by the type of you issue." should read: "Please use the template for your type of issue"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
.github/CONTRIBUTING.md
Outdated
|
||
### Way of operation | ||
|
||
1. The contributors will `Close` these Issues or PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean maintainers?
Suggestion: "The maintainers will Close
the issue or PR"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, you are right.
.github/CONTRIBUTING.md
Outdated
|
||
1. The contributors will `Close` these Issues or PR | ||
1. Not accepted feature request | ||
- Add `wontfix` label |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add the wontfix
label
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
.github/CONTRIBUTING.md
Outdated
1. The contributors will `Close` these Issues or PR | ||
1. Not accepted feature request | ||
- Add `wontfix` label | ||
2. Not obvious and Not responding |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "Not clear or unresponsive"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
.github/CONTRIBUTING.md
Outdated
1. Not accepted feature request | ||
- Add `wontfix` label | ||
2. Not obvious and Not responding | ||
- Not obvious: Problem is not obvious, or not reproduced. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "Not clear: Problem is not obvious or not reproducible"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
.github/ISSUE_TEMPLATE.md
Outdated
# What actually occurred | ||
|
||
# What version of the involved component |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "What was the version of the involved component"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
.github/ISSUE_TEMPLATE/feature.md
Outdated
You should label `feature-request`. | ||
|
||
|
||
If your purpose is different, please visit following links. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "If you issue is not a feature request, please visit one of the following links."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
.github/ISSUE_TEMPLATE/question.md
Outdated
|
||
Template: QUESTION | ||
|
||
This is an issue for a feature request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "This is a template for a general question"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh... sorry, 😓
.github/ISSUE_TEMPLATE/feature.md
Outdated
|
||
Template: FEATURE REQUEST | ||
|
||
This is an issue for a feature request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Replace "issue" with "template"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great!
.github/ISSUE_TEMPLATE/question.md
Outdated
You should label `question`. | ||
|
||
|
||
If your purpose is different, please visit following links. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: "If you issue is not a question, please visit one of the following links."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Thank you for @jonasbn !
@jonasbn , hello again!
It's been a long time, but this PR is an measure to deal with the problem we suffered before. #95 (comment)
I also added the issue template for common types of issues.
Please take a look whenever you have a time.
Thanks!