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

Small improvements for CONTRIBUTING.md #329

Merged
merged 23 commits into from
Apr 20, 2023

Conversation

chykon
Copy link
Contributor

@chykon chykon commented Mar 22, 2023

Description & Motivation

DEPENDS ON: #327

It is proposed to make small changes to CONTRIBUTING.md:

  • Add a link to SECURITY.md
  • Place GitHub Discussions above GitHub Issues, as it's worth listing easier (for a random outsider) ways to get help first
  • Fix names (vscode -> VSCode, StackOverflow -> Stack Overflow etc.)
  • Add recommendation to use VSCode extension for Dart support
  • Add a recommendation to use the recommended settings for the VSCode extension for Dart
  • Update guidance on recommended file header template
  • Update links
  • Other small changes

Related Issue(s)

No.

Testing

Not required.

Backwards-compatibility

Is this a breaking change that will not be backwards-compatible? If yes, how so?

No.

Documentation

Does the change require any updates to documentation? If so, where? Are they included?

Yes, the guide for contributors is changing a bit.

@chykon
Copy link
Contributor Author

chykon commented Mar 31, 2023

Removed the ignore pattern that was added to #327 (see #327 (comment))

@chykon chykon marked this pull request as ready for review March 31, 2023 20:06
Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for taking the time to make these improvements!

CONTRIBUTING.md Outdated Show resolved Hide resolved
@chykon chykon requested a review from mkorbel1 April 6, 2023 07:25
Copy link
Contributor

@mkorbel1 mkorbel1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thank you!

@mkorbel1 mkorbel1 merged commit 157883a into intel:main Apr 20, 2023
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.

2 participants