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

Create issue templates for this repo #108

Open
webknjaz opened this issue Apr 20, 2019 · 9 comments
Open

Create issue templates for this repo #108

webknjaz opened this issue Apr 20, 2019 · 9 comments
Labels
easy Easy for first pull request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@webknjaz
Copy link
Member

https://help.github.com/en/articles/manually-creating-a-single-issue-template-for-your-repository

@webknjaz webknjaz added help wanted Extra attention is needed good first issue Good for newcomers easy Easy for first pull request labels Apr 20, 2019
@Arfey
Copy link
Member

Arfey commented Apr 20, 2019

what about global issue templates for group?

@webknjaz
Copy link
Member Author

These should probably be more project-specific. Global ones should serve as fallbacks

@Arfey
Copy link
Member

Arfey commented Apr 20, 2019

Okay

This was referenced Oct 18, 2019
@ghost
Copy link

ghost commented Oct 18, 2019

Hi I submitted a PR for this issue; hope it's okay.

Based on the PR instructions, it says to add a "new news fragment" to the CHANGES folder with file name 108.doc (<issue_id>. type maybe feature not sure). However, I am unable to locate the CHANGES folder in the Master branch. Is there something I'm missing?

Thanks.

@Arfey
Copy link
Member

Arfey commented Oct 18, 2019

Sorry i don't know what you're talking about. Could u show where did u read about "new news fragment"?

@ghost
Copy link

ghost commented Oct 21, 2019

In the new issue description template the following items are listed.

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • Add a new news fragment into the CHANGES folder
    • name it <issue_id>.<type> (e.g. 588.bugfix)
    • if you don't have an issue_id change it to the pr id after creating the PR
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: Fix issue with non-ascii contents in doctest text files.

@Arfey
Copy link
Member

Arfey commented Oct 30, 2019

@DatscIY i think we can skip this part.

Add a new news fragment into the CHANGES folder

@webknjaz
Copy link
Member Author

FYI GitHub got feature updates for templates: https://github.blog/changelog/2019-10-28-new-issue-template-configuration-options/

@webknjaz webknjaz assigned ghost Oct 30, 2019
@webknjaz
Copy link
Member Author

@DatscIY Please add Closes #108 to your PR somewhere in its description so that GitHub would link it properly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy Easy for first pull request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants