Skip to content
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

Merged
merged 7 commits into from
Mar 20, 2018
Merged

Update contributing #121

merged 7 commits into from
Mar 20, 2018

Conversation

naokazuterada
Copy link
Owner

@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!

* 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
Copy link

codecov bot commented Mar 11, 2018

Codecov Report

Merging #121 into master will increase coverage by 1.91%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
MarkdownTOC.py 95.16% <0%> (+1.91%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 97e8952...d867a75. Read the comment docs.

@coveralls
Copy link

coveralls commented Mar 11, 2018

Coverage Status

Coverage remained the same at 93.252% when pulling d867a75 on update-contributing into 97e8952 on master.

@jonasbn
Copy link
Collaborator

jonasbn commented Mar 11, 2018

Hi @naokazuterada

I will have a look ASAP.

Copy link
Collaborator

@jonasbn jonasbn left a 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.

@@ -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.
Copy link
Collaborator

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"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


### Way of operation

1. The contributors will `Close` these Issues or PR
Copy link
Collaborator

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"

Copy link
Owner Author

@naokazuterada naokazuterada Mar 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, you are right.


1. The contributors will `Close` these Issues or PR
1. Not accepted feature request
- Add `wontfix` label
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the wontfixlabel

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

1. The contributors will `Close` these Issues or PR
1. Not accepted feature request
- Add `wontfix` label
2. Not obvious and Not responding
Copy link
Collaborator

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"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

1. Not accepted feature request
- Add `wontfix` label
2. Not obvious and Not responding
- Not obvious: Problem is not obvious, or not reproduced.
Copy link
Collaborator

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"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

# What actually occurred

# What version of the involved component
Copy link
Collaborator

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"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

You should label `feature-request`.


If your purpose is different, please visit following links.
Copy link
Collaborator

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."

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


Template: QUESTION

This is an issue for a feature request.
Copy link
Collaborator

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"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh... sorry, 😓


Template: FEATURE REQUEST

This is an issue for a feature request.
Copy link
Collaborator

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"

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great!

You should label `question`.


If your purpose is different, please visit following links.
Copy link
Collaborator

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."

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@naokazuterada
Copy link
Owner Author

naokazuterada commented Mar 20, 2018

@jonasbn Thank you so much!!

I correct almost everything you pointed out.
(I thought this might be a miss type)

I'm so appreciate for compensating for my lack of English skills! Very helpful!

@naokazuterada naokazuterada merged commit d867a75 into master Mar 20, 2018
@naokazuterada naokazuterada deleted the update-contributing branch March 20, 2018 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants