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.

Sign up for GitHub

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

Jump to bottom

Rename "Violations" and "Issues" tab in the web app report #4395

Open
sschuberth opened this issue Aug 26, 2021 · 3 comments
Open

Rename "Violations" and "Issues" tab in the web app report #4395

sschuberth opened this issue Aug 26, 2021 · 3 comments
Assignees
@tsteenbe
Labels
enhancement Issues that are considered to be enhancements reporter About the reporter tool

Comments

@sschuberth
Copy link
Member

For more clarity, the proposal is to rename "Violations" to "Policy Violations" and "Issues" to "Technical Issues", which should make more clear who in a workflow is responsible for addressing what.

Opinions @oss-review-toolkit/core-devs?
@sschuberth sschuberth added enhancement Issues that are considered to be enhancements reporter About the reporter tool labels Aug 26, 2021
@fviernau
Copy link
Member

My knowledge might be outdated, but I recall only using the term rule and rule violation.
I think changing that in the code base would be a lot of (unnecessary) work. Changing just the UI text in the report to policy violations would be ok for me, if we do not propagate the name change into code variables.

@sschuberth Have you considered the term "Rule Violations" actually?

@sschuberth
Copy link
Member Author

Changing just the UI text in the report to policy violations would be ok for me, if we do not propagate the name change into code variables.

Yes, I'm only talking about the web app reporter UI.

@sschuberth Have you considered the term "Rule Violations" actually?

No, but that term would be fine with me, too.

@tsteenbe tsteenbe self-assigned this Aug 31, 2021
tsteenbe added a commit that referenced this issue Sep 10, 2021
@tsteenbe
reporter-web-app: Rename 'Violations' tab in SummaryView
158c39d 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
tsteenbe added a commit that referenced this issue Sep 15, 2021
@tsteenbe
reporter-web-app: Rename 'Violations' tab in SummaryView
d7e3d51 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
tsteenbe added a commit that referenced this issue Sep 16, 2021
@tsteenbe
reporter-web-app: Rename 'Violations' tab in SummaryView
d360323 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
fviernau pushed a commit that referenced this issue Sep 16, 2021
@tsteenbe @fviernau
reporter-web-app: Rename 'Violations' tab in SummaryView
2a78b36 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
fviernau pushed a commit that referenced this issue Sep 17, 2021
@tsteenbe @fviernau
reporter-web-app: Rename 'Violations' tab in SummaryView
85e4a85 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
tsteenbe added a commit that referenced this issue Sep 17, 2021
@tsteenbe
reporter-web-app: Rename 'Violations' tab in SummaryView
7ffce10 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
tsteenbe added a commit that referenced this issue Sep 17, 2021
@tsteenbe
reporter-web-app: Rename 'Violations' tab in SummaryView
3563dea 
Align naming with ORT's API naming see for example ORT documentation in [1]
and [2] where 'policy rule violation' and `rule_violations` is used.

[1]: https://github.com/oss-review-toolkit/ort/blob/master/docs/config-file-ort-yml.md#resolving-policy-rule-violations
[2]: https://github.com/oss-review-toolkit/ort/blob/master/docs/file-rules-kts.md

Relates-to: #4395
Signed-off-by: Thomas Steenbergen <thomas.steenbergen@here.com>
@sschuberth sschuberth mentioned this issue Jan 26, 2024
Merged
@sschuberth
Copy link
Member Author

@tsteenbe any plans to continue here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsteenbe tsteenbe

Labels
enhancement Issues that are considered to be enhancements reporter About the reporter tool
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@sschuberth @tsteenbe @fviernau