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

Add some automation around checking commit style #94

Open
4 tasks
vadasambar opened this issue Oct 4, 2022 · 4 comments
Open
4 tasks

Add some automation around checking commit style #94

vadasambar opened this issue Oct 4, 2022 · 4 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@vadasambar
Copy link
Collaborator

Problem statement.
Some of the contributors to datadog-service haven't contributed to Keptn before so they usually don't know the commit and the PR style we follow. We have to tell them about this when they make their first PR.

Describe the solution you'd like
It'd be nice to have an automated check for commit and PR style. It could be a github workflow on PRs. The check should also suggest the right way to do things (i.e., how to fix the current commit or PR)

Additional context
We have a similar check in Keptn for PR titles (we use this github action for that)

TODO

  • Add PR title check
  • Add PR commit check
  • Make sure they work (screenshots or something else which makes it easier to review)
  • Raise a PR and get it reviewed
  • DONE
@vadasambar vadasambar added enhancement New feature or request good first issue Good for newcomers labels Oct 4, 2022
@vadasambar
Copy link
Collaborator Author

If you need help or clarification on the issue, please comment here or reach out to @vadasambar in Keptn slack.

@tarangverma
Copy link
Contributor

can i take up this issue

@tarangverma
Copy link
Contributor

additionally: can we add contributing guide to this repo is it a good option..

@vadasambar
Copy link
Collaborator Author

@tarangverma I am open to the idea.

Do you think we can improve/add something to https://github.com/keptn-sandbox/datadog-service#development? Or have a different CONTRIBUTING.md altogether? If yes, what are the benefits to do so?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants