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

Introduce commit message template and PR template #193

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mariyageorge01
Copy link
Contributor

Description

This PR deals with introducing a git commit template and a PR template.

GitHub issue

Fixes #192

How to test this?

Git commit template:

  • Checkout this branch and run yarn install.

PR template

  • It will be reflected when the branch is merged to main.

Checklist:

  • My code follows the guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

- introduced git commit template

Signed-off-by: Mariya George <[email protected]>
- introduced PR template

Signed-off-by: Mariya George <[email protected]>
- fixed the lint errors in pull_request_template.md

Signed-off-by: Mariya George <[email protected]>
@mariyageorge01
Copy link
Contributor Author

@joesepi @mscherer Can I get a review on this, please?

@mscherer
Copy link
Contributor

mscherer commented Oct 1, 2024

I am not sure it is worth adding more checks for the website, this seems like unneeded bureaucracy to me. I already dislike having to do the whole DCO stuff for a static website, so I am not keen on adding more.

This would also break the dependabot PR, which is the only type of contributions we have.

@mariyageorge01
Copy link
Contributor Author

I am not sure it is worth adding more checks for the website, this seems like unneeded bureaucracy to me. I already dislike having to do the whole DCO stuff for a static website, so I am not keen on adding more.

This PR does not add any checks. I just added a git commit template. I haven't added commitlint.

The commit message template will act as a guidance to the devs on what to include when they commit some changes. The devs can choose to ignore the template, if they wish to do so. But as long as we have the DC0 check, if there is no Signed-off-by line, the build will fail though.

This would also break the dependabot PR, which is the only type of contributions we have.

As I mentioned above, I have not added commitlint in this PR. I don't think adding a commit message template will break the dependabot PRs.


The purpose of this PR is to help guide the developers to write better commit messages and PR descriptions. This PR does not enforce anything.

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

Successfully merging this pull request may close these issues.

Introduce git commit message template and PR template
2 participants