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

Suggestion: Issue and pull request templates #73

Closed
munizart opened this issue Jan 19, 2018 · 5 comments
Closed

Suggestion: Issue and pull request templates #73

munizart opened this issue Jan 19, 2018 · 5 comments

Comments

@munizart
Copy link
Contributor

munizart commented Jan 19, 2018

Wouldn't it be nice to have templates for issues and pull requests for this repository?

I had scratched this yet for PRs:

Fix issue #[issue number].

Changes proposed by this pull request:
- Change 1
- Change 2
- Change 3

@[reviewer] and @[another reviewer], could you please review this PR?

Checklist:
- [x] Used template
- [ ] Described proposed changes
- [ ] Marked at least two reviewers
- [ ] Wrote tests

I think it would be nice to discuss the template and what is missing in the checklist.
Also, it would be great to have an contributing guide.

@danilowoz, any thoughts on that?

@danilowoz
Copy link
Owner

Sounds great!

But not all pull request will be about issues/fixes. It can be a new feature, improvements, etc. Maybe you just need to improve the title, you know?
And you can add a new section, asking if the change is a "breaking change" or not?

What do you think?
Thanks

Greeting, xaropês

@munizart
Copy link
Contributor Author

@danilowoz agreed, although the title is free for the author to choose.
Totally agree about a section for breaking changes.
I think we could replace Fix issue #[issue number] just Related issue #[issue number]. This would, probably, encourages contributors to open an issue to discuss changes.
BTW, I think there's things left to discuss here, like the checklists items, how many reviewers should be tagged (if it should).

Also the necessity of a contributing guide or code of conduct is something to discuss in another issue.

@danilowoz
Copy link
Owner

Nice!
I'm waiting for you PR :)

@danilowoz danilowoz changed the title Sugestion: Issue and pull request templates Suggestion: Issue and pull request templates Jan 26, 2018
@danilowoz
Copy link
Owner

Hey @munizart, how are doing?
So, would you like to keep this issue with you? Or can I open the community to make it?
I think it is a great improvement and I want to solve that :)

Thanks

@munizart
Copy link
Contributor Author

@danilowoz sorry, right now I can't make it. But it would be great if someone could take it from here
🦄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants