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

ci: pull request template #517

Merged
merged 15 commits into from
Mar 4, 2024
Merged

ci: pull request template #517

merged 15 commits into from
Mar 4, 2024

Conversation

d0choa
Copy link
Collaborator

@d0choa d0choa commented Mar 4, 2024

✨ Context

As discussed in @RobinM-code in #510, we would benefit from having a PR template so that contributors understand what are the expectations when opening new PRs.

🛠 What does this PR implement

A Github PR template.

🙈 Missing

Templates are a very subjective topic. I welcome any feedback you might have cc @RobinM-code @DSuveges @ireneisdoomed

🚦 Checks

  • covers one single feature (one change at a time)
  • documentation added/updated
  • there is no commented out code in this PR
  • follows conventional commits in PR title and commits.
  • is up-to-date with dev branch
  • tests have been added to verify that the new code works
  • passes local tests (make test)
  • passes pre-commits (e.g poetry run pre-commit run --all-files)

Copy link
Contributor

@ireneisdoomed ireneisdoomed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I have stylistic suggestions, based on the Transformers PR template
Currently our contribution guidelines are "polluted" with instructions about environment set up, we could improve this.

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
@@ -0,0 +1,28 @@
## ✨ Context

<!--- What's the context for the changes? If the changes are related to a specific issue, please [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to it:_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!--- What's the context for the changes? If the changes are related to a specific issue, please [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to it:_
<!---
Congratulations! You've made it this far!
Once merged, your PR is going to appear in the release notes with the title you set, so make sure it's a great title that fully reflects the extent of your contribution.
What's the context for the changes? If the changes are related to a specific issue, please [link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to it:_

d0choa and others added 3 commits March 4, 2024 15:16
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
@RobinM-code
Copy link
Contributor

Some nice work @d0choa, this will help for sure!

Also:

Currently our contribution guidelines are "polluted" with instructions about environment set up, we could improve this.

Agree with this :)

@DSuveges
Copy link
Contributor

DSuveges commented Mar 4, 2024

I think these are fine, if changes will be necessary later, it can always be updated.

Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
d0choa and others added 9 commits March 4, 2024 15:41
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Co-authored-by: Irene López <45119610+ireneisdoomed@users.noreply.github.com>
Copy link
Contributor

@ireneisdoomed ireneisdoomed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ty for the changes!

@d0choa d0choa merged commit 3eb8fba into dev Mar 4, 2024
4 checks passed
@d0choa d0choa deleted the do_pr_template branch March 4, 2024 16:30
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.

4 participants