Skip to content

Commit 9e9a4c8

Browse files
committed
[docs] Add a readme.md and basic design proposal guidance
Signed-off-by: Nick Volynkin <[email protected]>
1 parent aca86e1 commit 9e9a4c8

3 files changed

Lines changed: 117 additions & 0 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.idea
2+
.vscode
3+
.DS_Store

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Cozystack Community
2+
3+
Welcome to the central hub for the Cozystack community!
4+
5+
This repository serves as the home for everything related to how we collaborate, grow, and support each other as users,
6+
contributors, and maintainers of the Cozystack platform.
7+
8+
## Purpose
9+
10+
This repo contains (or will contain soon):
11+
12+
- Community resources and helpful links
13+
- Contribution guidance and how to get involved
14+
- Governance documents and decision-making processes
15+
- Feature proposals and discussions
16+
- ️ Meeting notes and community calls
17+
18+
We aim to make contributing to Cozystack open, transparent, and rewarding.
19+
20+
## Community Resources
21+
22+
- [Cozystack website](https://cozystack.io/)
23+
- [Telegram Chat (English)](https://t.me/cozystack)
24+
- [Telegram Chat (Russian)](https://t.me/cozystack_ru)
25+
- [CNCF Slack – #cozystack](https://cloud-native.slack.com/archives/C08BQJD95J7)
26+
- [Kubernetes Slack – #cozystack](https://kubernetes.slack.com/archives/C06L3CPRVN1)
27+
- [Cloud Native Computer Foundation (CNCF)](https://www.cncf.io/) — the foundation providing open governance and infrastructure support.
28+
- [Aenix](https://aenix.io) – the original creators of Cozystack and its current lead maintainers under CNCF governance.
29+
30+
## Get Involved
31+
32+
Whether you're reporting an issue, proposing a feature, joining a working group, or just curious — you're welcome here!
33+
34+
- Check out the [CONTRIBUTING.md](https://github.com/cozystack/cozystack/blob/main/CONTRIBUTING.md)
35+
file to learn more about how to participate.
36+
- You can also review our [GOVERNANCE.md](https://github.com/cozystack/cozystack/blob/main/GOVERNANCE.md)
37+
to understand how decisions are made and how maintainers operate.
38+
- We follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)
39+
to ensure a respectful and inclusive environment for all community members.
40+
- If you're using Cozystack, feel free to [add yourself to the ADOPTERS.md](https://github.com/cozystack/cozystack/blob/main/ADOPTERS.md)
41+
— we'd love to hear from you!
42+
- Thinking about a big feature or architectural change?
43+
Start with our [design proposal guidelines](https://github.com/cozystack/cozystack/blob/main/docs/design-proposals/README.md)
44+
to ensure a structured and collaborative discussion.
45+
46+
## Inspiration
47+
48+
This repository draws best practices and structural inspiration from the [KubeVirt community repository](https://github.com/kubevirt/community),
49+
which sets a great example of open collaboration in cloud-native infrastructure.

‎design-proposals/README.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Cozystack Design Proposals
2+
3+
This folder contains design proposals for features and architectural decisions that impact Cozystack as a whole.
4+
5+
## Purpose
6+
7+
Design proposals allow community members to share their ideas early, get feedback, and build consensus before implementation begins.
8+
The process is especially useful for:
9+
10+
- Architectural decisions that will shape multiple features in the future
11+
- Features that require choosing between competing architectural approaches with tradeoffs
12+
- Decisions that affect multiple components or APIs
13+
14+
By proposing designs up front, we aim to reduce risk and ensure the project evolves in a coordinated, community-driven way.
15+
16+
**Note:** Using the design proposal process is optional, but strongly encouraged—especially for non-trivial or cross-cutting work.
17+
18+
## How to Create a Proposal
19+
20+
1. Make a new directory under `./design-proposals` and create a README.md file in it:
21+
22+
```
23+
./design-proposals/<proposal-title>/README.md
24+
```
25+
26+
Describe your proposal in this file.
27+
28+
Put all additional materials, such as diagrams, reference docs, and others, in the same folder.
29+
Note that for diagrams you can use [Mermaid.js](https://mermaid.js.org/) markup, which is natively rendered on GitHub
30+
directly in the Markdown files.
31+
32+
1. Remember to include basic metadata at the top:
33+
34+
- Title
35+
- Author(s)
36+
- Date
37+
38+
1. As with all commits in CNCF projects, please sign the commit for a DCO check:
39+
40+
```bash
41+
git commit --signoff
42+
```
43+
44+
1. Submit a pull request with your proposal and request feedback.
45+
46+
To bring attention to your proposal, share it in the Cozystack community:
47+
48+
- Telegram: [English](https://t.me/cozystack)
49+
- CNCF Slack channel `#cozystack`
50+
- Kubernetes Slack channel `#cozystack`
51+
- Bi-weekly Cozystack community calls
52+
53+
## Approval Process
54+
55+
Proposals are reviewed in GitHub PRs. Once a proposal receives consensus from core maintainers (via `/lgtm` and comments), it will be merged and considered accepted. Merged proposals serve as a reference, not a binding spec.
56+
57+
## Proposal Drift
58+
59+
We understand that real-world implementation may diverge from initial designs. This is normal and expected.
60+
61+
While it's helpful to update the proposal if the divergence is significant, the **codebase and user documentation are the final source of truth**.
62+
63+
## Inspiration
64+
65+
This process is inspired by [KubeVirt's design proposals](https://github.com/kubevirt/community/tree/main/design-proposals) and [Kubernetes Enhancement Proposals](https://github.com/kubernetes/enhancements).

0 commit comments

Comments
 (0)