Add Issues and PR templates

fatih-yavuz / links.dev

A free linktree alternative only for devs. Get a nice page at links.dev/username. Simple site to group all your links. Register your username before someone else does.

MIT License

227 stars 149 forks source link

Add Issues and PR templates #175

Closed esau-morais closed 1 year ago

esau-morais commented 1 year ago

Description

What types of changes does your code introduce to links.dev?

:information_source: Put a x in one or more boxes that might apply to it

[ ] Sign up (register to links.dev)
[ ] Bug fix (non-breaking change which fixes an issue)
[X] Feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[X] Documentation (if none of the other choices apply)

Checklist

:information_source: This is simply a reminder of what we are going to look for before merging your code.

Mark the boxes with a x that are related to the PR. If you're unsure about any of them, don't hesitate to ask.

[ ] I have read the "How to sign up" section
[x] CI still works with my changes
[ ] I have added tests that prove my fix is effective or that my feature works
[X] I have added necessary documentation (if appropriate)

fatih-yavuz commented 1 year ago

This looks, sweet Esau

Can we introduce different templates per branch type? For example, the fix or feature branches can be named like issue-${number} so that we will ask some of the questions only on those branches:

CI still works with my changes
I have added tests that prove my fix is effective or that my feature works
I have added the necessary documentation (if appropriate) etc.

For registration PRs, I would only ask the following:

I have created my-links repository and added my page.json
my page.json contains my links, not others
I've updated registry.yaml

esau-morais commented 1 year ago

This looks, sweet Esau

Can we introduce different templates per branch type? For example, the fix or feature branches can be named like issue-${number} so that we will ask some of the questions only on those branches:

CI still works with my changes

I have added tests that prove my fix is effective or that my feature works

I have added the necessary documentation (if appropriate) etc.

For registration PRs, I would only ask the following:

I have created my-links repository and added my page.json

my page.json contains my links, not others

I've updated registry.yaml

I love the idea, I was actually unaware that it was possible to also create separate files for PR templates LOL, once I've never seen any org using it. Thank you! Suggestion applied.