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.

Sign up for GitHub

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

Jump to bottom

docs: Updated CONTRIBUTING and issue templates #560

Merged
merged 6 commits into from
Oct 29, 2021
Merged

docs: Updated CONTRIBUTING and issue templates #560

merged 6 commits into from
Oct 29, 2021

Conversation

fg-mindee
Copy link
Contributor

This PR introduces the following modifications:

  • updates contribution guidelines to point towards discussions for questions and issues for bug report & feature requests
  • Added an issue form for feature requests based on the one of torchvision
  • Switched the issue template of bug report to an issue form similar to the one of torchvision

Issue forms allow maintainers to make sections of an issue mandatory, they have been introduced recently to improve the os issue templates: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Any feedback is welcome!

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement labels Oct 29, 2021
@fg-mindee fg-mindee added this to the 0.4.1 milestone Oct 29, 2021
@fg-mindee fg-mindee self-assigned this Oct 29, 2021
@codecov
Copy link

codecov bot commented Oct 29, 2021 •
edited
Loading

Codecov Report

Merging #560 (607ad14) into main (368beeb) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #560   +/-   ##
=======================================
  Coverage   96.00%   96.00%           
=======================================
  Files         109      109           
  Lines        4180     4180           
=======================================
  Hits         4013     4013           
  Misses        167      167
Flag Coverage Δ
unittests 96.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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 368beeb...607ad14. Read the comment docs.

charlesmindee
charlesmindee approved these changes Oct 29, 2021
View reviewed changes
Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks!

@fg-mindee fg-mindee merged commit b149266 into main Oct 29, 2021
@fg-mindee fg-mindee deleted the contrib-improvement branch October 29, 2021 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charlesmindee charlesmindee charlesmindee approved these changes

Assignees

@fg-mindee fg-mindee

Labels
topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Milestone
0.4.1
Development

Successfully merging this pull request may close these issues.
2 participants
@fg-mindee @charlesmindee