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

doc: updating critical files #53

Merged
merged 4 commits into from
Mar 11, 2024
Merged

doc: updating critical files #53

merged 4 commits into from
Mar 11, 2024

Conversation

joesepi
Copy link
Member

@joesepi joesepi commented Mar 10, 2024

  • Updated CONTRIBUTING.md
  • Updated SECURITY.md
  • Removed MAINTAINERS.md in favor of CODEOWNERS
  • Removed CHANGELOG.md

Signed-off-by: Joe Sepi <sepi@joesepi.com>
@lehors
Copy link
Contributor

lehors commented Mar 11, 2024

CODEOWNERS is not a replacement for MAINTAINERS.md. CODEOWNERS is completely opaque, especially when it refers to some team whose definition isn't publicly accessible. MAINTAINERS.md is about documenting transparently who has write access to the repo and should also document how the list of maintainers is managed (i.e., the requirements and process for one to become a maintainer and for one to be retired).

@joesepi
Copy link
Member Author

joesepi commented Mar 11, 2024

CODEOWNERS is not a replacement for MAINTAINERS.md. CODEOWNERS is completely opaque, especially when it refers to some team whose definition isn't publicly accessible. MAINTAINERS.md is about documenting transparently who has write access to the repo and should also document how the list of maintainers is managed (i.e., the requirements and process for one to become a maintainer and for one to be retired).

@lehors - I didn't realize the teams are opaque. You are right. However, this maintainers file is a stub, so I created a new issue to add back a valid MAINTAINERS.md file and there is already an issue you created as well that is specific to the taxonomy repo:

Signed-off-by: Joe Sepi <sepi@joesepi.com>
SECURITY.md Show resolved Hide resolved
@joesepi joesepi requested a review from lhawthorn March 11, 2024 17:47
Signed-off-by: Joe Sepi <sepi@joesepi.com>
Copy link
Member

@lhawthorn lhawthorn left a comment

Choose a reason for hiding this comment

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

LGTM.

Signed-off-by: Joe Sepi <sepi@joesepi.com>
@joesepi joesepi merged commit a2008dc into instructlab:main Mar 11, 2024
1 check passed
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.

3 participants