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

refactor(workflow): pr title validation update #1389

Merged
merged 1 commit into from
Nov 29, 2024

Conversation

ulfgebhardt
Copy link
Contributor

🍰 Pullrequest

pr title validation update requested by a comment on the implementing PR #1379 (comment)

Adds 4 new types for pr scopes observed in cypht:

  • frontend
  • backend
  • frontend/backend
  • backend/frontend

Furhtermore a comprehensive guide was added to the pull request template to make it easier for people to fullfil this requirement.

Example

image

Issues

Todo

  • Verify that no scope, observed lately, is missing

@ulfgebhardt ulfgebhardt self-assigned this Nov 26, 2024
@ulfgebhardt ulfgebhardt added the refactor Includes reducing technical debt label Nov 26, 2024
@mercihabam
Copy link
Member

@ulfgebhardt, thank you for your response to my comment!

Here is my feedback:

  • I suggest excluding the scopes "cypht" and "other" as they do not indicate that any specific part of the project has been affected.
  • docs sounds more appropriate as a scope compared to docu.
  • In the proposed update, we have both frontend/backend and backend/frontend. I recommend keeping only one variation for consistency.
  • These additional scopes could be useful: modules/output, modules/handler, tests/unit, and tests/e2e.

@ulfgebhardt
Copy link
Contributor Author

@ulfgebhardt, thank you for your response to my comment!

Here is my feedback:

  • I suggest excluding the scopes "cypht" and "other" as they do not indicate that any specific part of the project has been affected.
  • docs sounds more appropriate as a scope compared to docu.
  • In the proposed update, we have both frontend/backend and backend/frontend. I recommend keeping only one variation for consistency.
  • These additional scopes could be useful: modules/output, modules/handler, tests/unit, and tests/e2e.

I implemented your suggestions, except the removal of other. I can remove it if you want, but its always useful to give people an option to escape things in case you did not think about everything.

Furthermore I suggest to simplify your suggestions further:

  • instead of modules/output and modules/handler i suggest to just use modules - or better sigular module
  • instead of tests/unit tests/e2e I suggest to use just unit and e2e since your title would be something like test(unit): my test.

Let me know what you think

@mercihabam
Copy link
Member

That works for me, please go ahead!

@ulfgebhardt ulfgebhardt force-pushed the pr-title-validation-update branch 2 times, most recently from 544bb8f to d18b772 Compare November 28, 2024 18:44
Adds 4 new types for pr scopes observed in cypht:
- frontend
- backend
- frontend/backend
- backend/frontend

Furhtermore a comprehensive guide was added to the pull request template
to make it easier for people to fullfill this requirement.

adjust scopes according to requirements

updated scopes according to agreement

adjusted example in PR template
@ulfgebhardt ulfgebhardt force-pushed the pr-title-validation-update branch from d18b772 to 181c3ff Compare November 28, 2024 18:45
@ulfgebhardt
Copy link
Contributor Author

That works for me, please go ahead!

Please have another look.

@mercihabam
Copy link
Member

Looks good!

@mercihabam mercihabam merged commit 42a8b63 into master Nov 29, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Includes reducing technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants