Update community repository for podman shared documentation#1
Update community repository for podman shared documentation#1mohanboddu wants to merge 2 commits into
Conversation
Honny1
left a comment
Honny1
left a comment
There was a problem hiding this comment.
Should all maintaniers have access to this repor?
| More details on this are below, in the "Describe your changes in Commit Messages" section. | ||
|
|
||
| This repository follows a two-ack policy for merges. | ||
| PRs will be approved by an approver listed in [`OWNERS`](OWNERS) file in the root of the repository. |
There was a problem hiding this comment.
I guess we never removed this, we no longer have OWNER files
There was a problem hiding this comment.
I changed it to
PRs will be approved by maintainers listed in the `MAINTAINERS.md` file in the repository.
Let me know if its okay or should I change it.
|
This might be bikeshedding but I'd prefer to keep the top-level I'd also flatten the repo file structure - governance, code of conduct, contributing, and security all have to do with community and contributing, no need to hide them under several layers of directories. Open to discussion on this too, but just putting my idea into the hat. |
|
@danishprakash @Luap99 @ashley-cui I think I got all fixed up in my local repo, before I push it should I flatten the directory structure or do you have any other suggestions. The current directory structure was a suggestion from Paul https://matrix.to/#/!dEOtPtLYATRcPwrPhS:matrix.org/$5uUIRLZGpscrsi4JE9uOglkToT2czLAOCC6E6AAyF0c?via=matrix.org&via=fedora.im&via=holzinger.dev |
|
I'm in favor of @ashley-cui's earlier suggestion of a flat directory structure; It's best if we keep things simple, I don't really see the need for directories, at least not at this point.
|
|
I think Governance should be top level, for the rest I do not mind much but am totally fine with all top level. |
This repository centralizes project-wide governance, contribution guidelines, and community documentation for the Podman Container Tools organization. Files included: - Governance documents (GOVERNANCE.md) - Code Of Conduct documents (CODE-OF-CONDUCT.md) - Contribution guidelines (CONTRIBUTING.md, CONTRIBUTING_GO.md, SECURITY.md) - LLM Policy (LLM_POLICY.md) - Meeting minutes from podman/contrib/minutes/ - README.md explaining the repository's purpose and structure Signed-off-by: Mohan Boddu <mboddu@redhat.com>
| * Regular contribution of pull requests to the Podman project or its subprojects | ||
| * Triage of GitHub issues on the Podman project or its subprojects | ||
| * Regularly fixing GitHub issues on the Podman project or its subprojects | ||
| * Following the [reviewing guide](./REVIEWING.md) and [issue triage guide](./TRIAGE.md) |
There was a problem hiding this comment.
same as previous comment; there's no REVIEWING.md
Co-authored-by: Danish Prakash <contact@danishpraka.sh>
| They also will be invited to the `podman-container-tools` GitHub organization as member. | ||
|
|
||
| #### The process of becoming a Reviewer is: | ||
| 1. The contributor must be sponsored by a Maintainer. That sponsor will open a PR against the appropriate repository, which adds the nominee to the [MAINTAINERS.md](./MAINTAINERS.md) file as a reviewer. |
There was a problem hiding this comment.
There's no MAINTAINERS.md in this repo.
| the 'CI/CD Admin' *Organization* role which enables them access to organization-wide runner and secret configuration, or they can ask for the 'CI/CD Admin' *Repository* role (must be granted per repository) to access the repository level runners or secrets. | ||
|
|
||
| #### Process of becoming a maintainer: | ||
| 1. A current reviewer must be sponsored by a Maintainer of the repository in question or a Core Maintainer. The Maintainer or Core Maintainer will open a PR against the repository and add the nominee as a Maintainer in the [MAINTAINERS.md](./MAINTAINERS.md) file. The need for a sponsor is removed for Emeritus Maintainers, who may open this pull request themselves. |
| and decision making in all repositories. | ||
|
|
||
| #### Process of becoming a Core Maintainer: | ||
| 1. A current maintainer must be sponsored by Core Maintainer. The Core Maintainer will open a PR against the main Podman repository and add the nominee as a Core Maintainer in the [MAINTAINERS.md](./MAINTAINERS.md) file. |
| - [skopeo](https://github.com/podman-container-tools/skopeo) | ||
| - [container-libs](https://github.com/podman-container-tools/container-libs) | ||
|
|
||
| ## Topics |
There was a problem hiding this comment.
I would add links to each topic in each project documentation. For example, you could add a link here on how to run integration tests in Podman. It could be something like: 'Here are useful links related to this topic for each project:
- Podman: Integration tests (link to readme in podman.)
- ...
7 participants
This repository centralizes project-wide governance, contribution guidelines, and community documentation for the Podman Container Tools organization.
Files included: