Skip to content

Commit c4a016f

Browse files
Merge pull request #49 from moshloop/patch-1
[WIP] Create CONTRIBUTING.md
2 parents 8de54fe + 5be552d commit c4a016f

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CONTRIBUTING.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# CONTRIBUTING
2+
3+
This repository hosts lasting documents for the OpenGitOps project, which are versioned and released together.
4+
5+
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.
6+
7+
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.
8+
Other content, such as white papers, case studies, architectural patterns, tool and technology comparisons, or tutorials, are also good candidates for inclusion.
9+
Use your imagination!
10+
11+
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).
12+
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.
13+
14+
However it's created, all content in this repo must meet the acceptance criteria below to be considered for inclusion.
15+
Pull requests must also receive at least two approvals from project maintainers.
16+
We look forward to your contributions!
17+
18+
## Minimum Acceptance Criteria:
19+
20+
* Copyright is assigned to OpenGitops / CNCF project
21+
* Content is not a duplicate (for version changes in technology, submit a new version of an existing article)
22+
* 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
23+
* Content should not contain branding for anything other than the OpenGitops project
24+
* Content must be in markdown format
25+

0 commit comments

Comments
 (0)