Skip to content

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 6 commits into from
Feb 10, 2023

Conversation

ldennington
Copy link
Collaborator

@ldennington ldennington commented Feb 10, 2023

Open source release requires addition of a few files, namely:

  1. LICENSE: already added with open source release: add LICENSE #18
  2. CONTRIBUTING.md
  3. CODE_OF_CONDUCT
  4. SECURITY.md
  5. CODEOWNERS
  6. SUPPORT.md

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).

@ldennington ldennington self-assigned this Feb 10, 2023
@ldennington ldennington force-pushed the ldennington/additional-os-release-files branch 2 times, most recently from e606597 to 1aa45b5 Compare February 10, 2023 21:31
Copy link
Collaborator

@vdye vdye 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, thanks for getting all of this documentation together!

ldennington and others added 6 commits February 10, 2023 14:43
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]>
@ldennington ldennington force-pushed the ldennington/additional-os-release-files branch from 1aa45b5 to 336deed Compare February 10, 2023 21:45
@ldennington ldennington merged commit 65332ba into main Feb 10, 2023
@vdye vdye deleted the ldennington/additional-os-release-files branch May 3, 2023 17:51
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