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

Add GitHub templates #17

Merged
merged 3 commits into from
Apr 22, 2021
Merged

Conversation

andygrove
Copy link
Member

Here are suggested issue templates for bugs and features, as well as a PR template that will prompt users to enter the issue that the PR is closing.

@codecov-commenter
Copy link

Codecov Report

Merging #17 (6ee3ade) into master (74d3567) will not change coverage.
The diff coverage is n/a.

❗ Current head 6ee3ade differs from pull request most recent head e58c1ba. Consider uploading reports for the commit e58c1ba to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master      #17   +/-   ##
=======================================
  Coverage   82.47%   82.47%           
=======================================
  Files         162      162           
  Lines       43414    43414           
=======================================
  Hits        35805    35805           
  Misses       7609     7609           

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 74d3567...e58c1ba. Read the comment docs.

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Looks like an improvement to me. I have a few suggestions, but I think it would be fine to merge as is too

Comment on lines +10 to +12
**Describe the bug**
A clear and concise description of what the bug is.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like to try and lead people away from a free form description of bugs as that often ends up more confusing (to me)

What would you think about the sections:

  1. To Reproduce
  2. Expected Behavior
  3. Actual Behavior
  4. Additional Context

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, that looks good to me.

.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
Copy link
Member

@jorgecarleitao jorgecarleitao left a comment

Choose a reason for hiding this comment

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

Awesome, great write up and all very sensible. 👍

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.

4 participants