Skip to content

Add issue and PR templates, clarify guidelines #1297

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

Merged
merged 8 commits into from
May 29, 2020
Merged

Conversation

dcodeIO
Copy link
Member

@dcodeIO dcodeIO commented May 27, 2020

As a follow-up to the respective agenda item at our 12th Working Group meeting, this PR adds relatively light issue and PR templates to the repository and clarifies a few points within the contributing guidelines. Here's the diff:


Submitting Pull Requests

[...]

  • Consider creating an issue to discuss first and later link to it from the PR if this is not a trivial fix.

[...]

Please note that if a pull request is rather complicated, i.e. touches lots of internals, or became stale, it is not uncommon that a core contributor performs the final integration to get it done in good conscience while naming you as a co-author.

Thank you!


Doesn't go overboard with the templates yet, and mostly makes sure that everyone is aware up-front of how complicated PRs may evolve in an attempt to avoid disappointment or conflict. Please let me know if this looks good to you! cc @MaxGraey @torch2424 @jtenner @DuncanUszkay1

@dcodeIO
Copy link
Member Author

dcodeIO commented May 28, 2020

Alright, added a checkbox to PRs (but not to issues, seems overkill) and inserted an emoji so it is at least a little friendly. On new PRs, this is how it looks:

prtemplate

Let me know what you think 🙂

@dcodeIO dcodeIO self-assigned this May 28, 2020
@dcodeIO
Copy link
Member Author

dcodeIO commented May 29, 2020

Merging to get this out of the way. If there are ideas to improve the templates further, feel free to create a follow-up PR :)

@dcodeIO dcodeIO merged commit 40f889e into master May 29, 2020
@torch2424
Copy link
Contributor

torch2424 commented May 29, 2020

Oh yeah this looks great! Glad you merged it 😄 👍 @dcodeIO

@dcodeIO dcodeIO deleted the process-template branch June 11, 2020 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants