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.

Sign up for GitHub

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

Update contributing.md #86

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update contributing.md #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 20 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,29 @@

This repository hosts lasting documents for the OpenGitOps project, which are versioned and released together.

In addition to contributions to the ongoing evolution of the GitOps [Principles](hhttps://github.com/open-gitops/documents/blob/v1.0.0/PRINCIPLES.md) and [Glossary](https://github.com/open-gitops/documents/blob/v1.0.0/GLOSSARY.md), OpenGitOps project is looking for additional types of content to help new and existing GitOps practitioners learn from each other on their journey.
Before contributing, please review the [OpenGitOps Contributing Guidelines](https://github.com/open-gitops/community-health-files/blob/main/CONTRIBUTING.md). This document provides essential details on how to contribute, including information about discussions, meetings, the Code of Conduct, and other important guidelines for engaging with the OpenGitOps community.
Copy link
Member

Choose a reason for hiding this comment

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

I think the URL here is incorrect. What is the community-health-files repository? Do you refer to the CONTRIBUTING.md itself here?


These may include content initially envisioned in the [Work Products](https://github.com/cncf/tag-app-delivery/blob/main/gitops-wg/charter.md#work-products-wip) section of GitOps Working Group charter: methodologies and approaches documents, a GitOps landscape document, or working examples for getting started.
Other content, such as white papers, case studies, architectural patterns, tool and technology comparisons, or tutorials, are also good candidates for inclusion.
Use your imagination!
## Contribution Guidelines

It's encouraged to first discuss any ideas or questions asynchronously with the GitOps community using [OpenGitOps project discussions](https://github.com/open-gitops/project/discussions).
These discussion topics are regularly highlighted in the twice-monthly community meetings, and in some cases, special teams are formed within OpenGitOps to collaborate on specific content topics raised in these discussions.
In addition to contributions to the ongoing evolution of the GitOps [Principles](https://github.com/open-gitops/documents/blob/v1.0.0/PRINCIPLES.md) and [Glossary](https://github.com/open-gitops/documents/blob/v1.0.0/GLOSSARY.md), OpenGitOps is looking for additional types of content to help new and existing GitOps practitioners learn from each other on their journey.

However it's created, all content in this repo must meet the acceptance criteria below to be considered for inclusion.
Pull requests must also receive at least two approvals from project maintainers.
We look forward to your contributions!
These may include content initially envisioned in the [Work Products](https://github.com/cncf/tag-app-delivery/blob/main/gitops-wg/charter.md#work-products-wip) section of the GitOps Working Group charter, such as methodologies and approaches documents, a GitOps landscape document, or working examples for getting started. Other content, such as white papers, case studies, architectural patterns, tool and technology comparisons, or tutorials, are also good candidates for inclusion. Use your imagination!

## Discussion and Approval

We encourage you to first discuss any ideas or questions asynchronously with the GitOps community using [OpenGitOps project discussions](https://github.com/open-gitops/project/discussions). These discussions are highlighted in the twice-monthly community meetings, and sometimes special teams are formed to collaborate on specific content topics.

## Minimum Acceptance Criteria:
## Minimum Acceptance Criteria

* Copyright is assigned to OpenGitops / CNCF project
* Content is not a duplicate (for version changes in technology, submit a new version of an existing article)
* Content is informational and not promotional, Tutorials and case studies of vendor technology are allowed, but promotional content is limited to 1 line and 1 link (excluding any links to free trials in the requirements section) at the start or end of the content
* Content should not contain branding for anything other than the OpenGitops project
* Content must be in markdown format
All content in this repo must meet the following acceptance criteria to be considered for inclusion:

* **Developer Certificate of Origin (DCO):** Commit sign-off is required for all contributions.
* **Copyright:** Copyright must be assigned to OpenGitOps / CNCF project.
* **Originality:** Content must not be a duplicate. For version changes in technology, submit a new version of an existing article.
* **Informational:** Content must be informational and not promotional. Tutorials and case studies of vendor technology are allowed, but promotional content is limited to one line and one link (excluding any links to free trials) at the start or end of the content.
* **Branding:** Content should not contain branding for anything other than the OpenGitOps project.
* **Format:** Content must be in markdown format.

Pull requests must also receive at least two approvals from project maintainers.

We look forward to your contributions!