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

chore: use new SECURITY.md template #891

Merged
merged 2 commits into from Dec 7, 2023
Merged

Conversation

SebastianBezold
Copy link
Contributor

WHAT

This PR updates the SECURITY.md file to follow the most recent template

WHY

The new template explains usage of GitHub security advisories

FURTHER NOTES

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Closes #888

@wolf4ood
Copy link
Contributor

Hi @SebastianBezold
thanks for the PR,

seems that the MD linter is complaining here. Once fixed we can merge it

Thanks

@SebastianBezold
Copy link
Contributor Author

Hi @SebastianBezold thanks for the PR,

seems that the MD linter is complaining here. Once fixed we can merge it

Thanks

HI @wolf4ood,

oh sorry, missed that. I just took the template that is used everywhere. Do you want me to fix the findings and have a slightly different template formatting?
Changes would be Headline level and proper markdown link instead of bare-URL

@paullatzelsperger
Copy link
Contributor

Hi @SebastianBezold thanks for the PR,
seems that the MD linter is complaining here. Once fixed we can merge it
Thanks

HI @wolf4ood,

oh sorry, missed that. I just took the template that is used everywhere. Do you want me to fix the findings and have a slightly different template formatting? Changes would be Headline level and proper markdown link instead of bare-URL

@SebastianBezold isn't the markdown linter mandatory in all projects? I mean, wouldn't that formatting issue have surfaced somewhere else too then?

@SebastianBezold
Copy link
Contributor Author

Hi @SebastianBezold thanks for the PR,
seems that the MD linter is complaining here. Once fixed we can merge it
Thanks

HI @wolf4ood,
oh sorry, missed that. I just took the template that is used everywhere. Do you want me to fix the findings and have a slightly different template formatting? Changes would be Headline level and proper markdown link instead of bare-URL

@SebastianBezold isn't the markdown linter mandatory in all projects? I mean, wouldn't that formatting issue have surfaced somewhere else too then?

Hi @paullatzelsperger,

not that i know?! Don't remember any discussion on the mailing list or a TRG being present for that.
The only place I know has a markdown linter is the Tractus-X website. This was added, because we have so many different contributors there. But this is also being cheated, since some are adding .mdx files and they have been configured to be ignored

@paullatzelsperger
Copy link
Contributor

paullatzelsperger commented Dec 5, 2023

Hi @paullatzelsperger,

not that i know?! Don't remember any discussion on the mailing list or a TRG being present for that. The only place I know has a markdown linter is the Tractus-X website. This was added, because we have so many different contributors there. But this is also being cheated, since some are adding .mdx files and they have been configured to be ignored

nice. will kick out the linter, and as soon as that is done, you can rebase this PR, which should solve the issues.
PR to remove the linter: #905

Copy link

sonarcloud bot commented Dec 7, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@paullatzelsperger
Copy link
Contributor

paullatzelsperger commented Dec 7, 2023

@SebastianBezold i've updated the SECURITY.md, as it seems there is some discord within the team as to whether we should kick the linter or not.

@paullatzelsperger paullatzelsperger merged commit 3f689ad into main Dec 7, 2023
25 checks passed
@paullatzelsperger paullatzelsperger deleted the update-security-file branch December 7, 2023 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

Outdated SECURITY.md
3 participants