-
Notifications
You must be signed in to change notification settings - Fork 28
open source release: add required files #19
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e606597
to
1aa45b5
Compare
vdye
reviewed
Feb 10, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, thanks for getting all of this documentation together!
To align with the requirements for open source release and formatting of files that will be added in upcoming patches, update existing README links and add a section linking to the LICENSE file. Signed-off-by: Lessley Dennington <[email protected]>
A CONTRIBUTING.md file is one of the requirements for releasing projects as open source. Add CONTRIBUTING.md file with instructions on expected workflows accordingly. Signed-off-by: Lessley Dennington <[email protected]>
A code of conduct is one of the requirements for releasing projects as open source. Add CODE_OF_CONDUCT.md file containing the expectations for those maintaining/contributing to the project accordingly. Signed-off-by: Lessley Dennington <[email protected]>
A file directing users to the proper place to report security issues is one of the requirements for releasing projects as open source. Add SECURITY.md file pointing users to the GitHub Bug Bounty program accordingly. Signed-off-by: Lessley Dennington <[email protected]>
A file with maintainer handles is one of the requirements for releasing projects as open source. Add CODEOWNERS file with maintainer names accordingly. Signed-off-by: Lessley Dennington <[email protected]>
A file directing users to resources for support is one of the requirements for releasing projects as open source. Add SUPPORT.md file clarifying the project status and where to go file feature requests, bug reports, and general questions/requests for help. Signed-off-by: Lessley Dennington <[email protected]>
1aa45b5
to
336deed
Compare
vdye
approved these changes
Feb 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Open source release requires addition of a few files, namely:
This change also contains a few small modifications to the
README
, both to link to and align with the link formatting of the above files).