Create issue templates for this repo

aio-libs / create-aio-app

The boilerplate for aiohttp. Quick setup for your asynchronous web service.

https://create-aio-app.readthedocs.io/

MIT License

310 stars 89 forks source link

Create issue templates for this repo #108

Open webknjaz opened 5 years ago

webknjaz commented 5 years ago

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

Arfey commented 5 years ago

what about global issue templates for group?

webknjaz commented 5 years ago

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

Arfey commented 5 years ago

Okay

ghost commented 5 years ago

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 (. 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 commented 5 years ago

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

ghost commented 5 years ago

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 commented 4 years ago

@DatscIY i think we can skip this part.

Add a new news fragment into the CHANGES folder

webknjaz commented 4 years ago

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

webknjaz commented 4 years ago

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