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

Update contributing.md #86

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

Conversation

juliafmorgado
Copy link
Contributor

Enhance contributing.md, link to org-wide default file, and mention commits need DCO

Related to #85

@todaywasawesome todaywasawesome added documentation Improvements or additions to documentation help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Sep 4, 2024
@todaywasawesome todaywasawesome self-assigned this Nov 20, 2024
Copy link
Member

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

Good start

@@ -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?

Copy link
Member

@niklasmtj niklasmtj left a comment

Choose a reason for hiding this comment

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

Afar from that one comment it looks super good. Thank you so much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants