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

added pull request template #74

Merged
merged 2 commits into from
Sep 10, 2022
Merged

Conversation

MitchellBerend
Copy link
Collaborator

I thought it would be nice to have a pr template so I took inspiration from the kubernetes one. This aims to have a more consistent process for prs moving forward.

@MitchellBerend MitchellBerend added the documentation Improvements or additions to documentation label Sep 9, 2022
@chshersh
Copy link
Owner

chshersh commented Sep 9, 2022

@MitchellBerend This is a great idea 👏🏻

My only feedback would be to simplify the template as tool-sync is not as complicated a project as K8S 😅 tool-sync also has a much smaller user base. So we can grow the number of contributors by lowering contributing requirements at this stage. In my vision, long PR templates can be off-putting when all people want is to add a patch.

A few remarks:

  1. I don't think we need to mention CONTRIBUTING.md and we can rely on GitHub UI here that warns about reading CONTRIBUTING.md. It's also my general expectation that people read the contributing guide before contributing to the project.
  2. The /kind commands can be removed. We don't have the tooling to automatically set labels based on this and we can set them manually after PR is open.
  3. External contributors can't set the labels on their own.

Based on these remarks, I propose the following template:

<--! PR title template: [#ISSUE_NUMBER] <short description>
     Example:           [#42] Solve problem X
-->

Resolves #PUT_ISSUE_NUMBER_HERE_IF_APPLICABLE

Write description of your changes here

### Additional tasks

- [ ] Documentation for changes provided/changed
- [ ] Tests added

@MitchellBerend
Copy link
Collaborator Author

long PR templates can be off-putting when all people want is to add a patch.

I can definitely understand that a long doc can be off putting for others even though I like longer docs.
I will add your template since I think we should have some template so there is some amount of similar structure in prs.

@MitchellBerend
Copy link
Collaborator Author

Is there a way to skip ci for changes like this? I don't think it makes sense to waste resources when a template or README.md gets changed since we don't have doc tests (yet).

@chshersh
Copy link
Owner

@MitchellBerend You can add [skip ci] to the commit message and CI won't run for this commit. It can be handy for documentation-only changes

@chshersh chshersh merged commit be5c9bc into chshersh:main Sep 10, 2022
@MitchellBerend MitchellBerend deleted the pr_template branch September 10, 2022 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ⚗️ dx
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants