Files
cozystack/CONTRIBUTING.md
Nick Volynkin d69a9c4862 [docs] Proofread the readme and contributing
Fix a few errors here and there.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
2025-04-09 11:09:19 +03:00

1.6 KiB

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.

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
  • 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, or start a new GitHub discussion.

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