mirror of
https://github.com/cozystack/cozystack.git
synced 2026-10-30 16:47:20 +09:00
Myasnikov DaniilandClaude Opus 4.8
e180a8142a
Add an issue-template chooser and a feature-request template, and document in CONTRIBUTING and the README where each kind of contribution belongs: - bugs and concrete features -> issues in this repo - questions and early ideas -> GitHub Discussions - cross-cutting / architectural changes -> design proposals in cozystack/community Also reconciles the README, which routed feature requests to a Discussions category while the issue tracker is actually used for kind/feature issues. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: Myasnikov Daniil <myasnikovdaniil2001@gmail.com>
60 lines
2.8 KiB
Markdown
60 lines
2.8 KiB
Markdown
# Contributing to Cozystack
|
|
|
|
Welcome! We are glad that you want to contribute to our Cozystack project! 💖
|
|
|
|
As you get started, you are in the best position to give us feedbacks on areas of our project that we need help with, including:
|
|
|
|
* Problems found while setting up the development environment
|
|
* Gaps in our documentation
|
|
* Bugs in our GitHub actions
|
|
|
|
First, though, it is important that you read the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
|
|
|
|
The guidelines below are a starting point. We don't want to limit your
|
|
creativity, passion, and initiative. If you think there's a better way, please
|
|
feel free to bring it up in a GitHub discussion, or open a pull request. We're
|
|
certain there are always better ways to do things, we just need to start some
|
|
constructive dialogue!
|
|
|
|
## Ways to contribute
|
|
|
|
We welcome many types of contributions including:
|
|
|
|
* New features
|
|
* Builds, CI/CD
|
|
* Bug fixes
|
|
* [Documentation](https://GitHub.com/cozystack/cozystack-website/tree/main)
|
|
* Issue Triage
|
|
* Answering questions on Slack or GitHub Discussions
|
|
* Web design
|
|
* Communications / Social Media / Blog Posts
|
|
* Events participation
|
|
* Release management
|
|
|
|
## Ask for Help
|
|
|
|
The best way to reach us with a question when contributing is to drop a line in
|
|
our [Telegram channel](https://t.me/cozystack), or start a new GitHub discussion.
|
|
|
|
## Where do I file?
|
|
|
|
Cozystack work is split across two repositories. Use this table to land in the right place:
|
|
|
|
| You have… | Where it goes |
|
|
|---|---|
|
|
| A **bug** | [New issue → Bug report](https://github.com/cozystack/cozystack/issues/new/choose) in this repo (`kind/bug`) |
|
|
| A **concrete, scoped feature** | [New issue → Feature request](https://github.com/cozystack/cozystack/issues/new/choose) in this repo (`kind/feature`) |
|
|
| A **usage question** or an early idea | [GitHub Discussions](https://github.com/cozystack/cozystack/discussions) |
|
|
| A **cross-cutting / architectural change** — affects multiple components or APIs, or needs a decision before code | A [design proposal](https://github.com/cozystack/community/tree/main/design-proposals) in the [**community**](https://github.com/cozystack/community) repo |
|
|
| **Governance, process, or community** matters | The [community](https://github.com/cozystack/community) repo |
|
|
|
|
Rule of thumb: **bugs and concrete features live here; "what or whether we should build it" lives in [community](https://github.com/cozystack/community)** as a design proposal or discussion. A large feature often starts as a Discussion, graduates to a design-proposal PR, then spawns implementation issues here.
|
|
|
|
## Raising Issues
|
|
|
|
When raising issues, please specify the following:
|
|
|
|
- A scenario where the issue occurred (with details on how to reproduce it)
|
|
- Errors and log messages that are displayed by the involved software
|
|
- Any other detail that might be useful
|