search

cnoe-io / stacks

Apache License 2.0
4 stars 12 forks source link

Feature: CONTRIBUTING guidelines #8

Open omrishiv opened 3 months ago

omrishiv commented 3 months ago

Have you searched for this feature request?

Problem Statement

As a newcomer (or a regular committer) it would be great to have contribution guidelines. A set of guidelines for how to structure the new stacks and maybe some example anti-patterns to stay away from would be great.

Possible Solution

Create a CONTRIBUTING.md with some guidance

Alternatives Considered

No response

nabuskey commented 1 week ago

Some examples for what we might want in guidelines:

  1. Version pinning if remote helm repos are used.
  2. When to use helm chart vs manifests.
  3. Application Sets vs Applications.
  4. Readme essentials:
    • Overview: What does this do? Why should you care?
    • Optional architecture diagram.
    • Relevant links for further reading.