|
| 1 | +--- |
| 2 | +sidebar_position: 1 |
| 3 | +title: Helm Community |
| 4 | +--- |
| 5 | + |
| 6 | +<!-- |
| 7 | +THIS FILE IS AUTOMATICALLY IMPORTED FROM THE HELM/COMMUNITY REPOSITORY |
| 8 | +DO NOT EDIT THIS FILE DIRECTLY - IT WILL BE OVERWRITTEN |
| 9 | +
|
| 10 | +TO MAKE CHANGES: |
| 11 | +- Edit the source file at: https://github.com/helm/community/blob/main/README.md |
| 12 | +--> |
| 13 | + |
| 14 | +Welcome to the Helm community! |
| 15 | + |
| 16 | +This is the starting point for becoming a contributor to the Helm project - improving docs, improving code, giving talks etc. |
| 17 | + |
| 18 | +## Communicating |
| 19 | + |
| 20 | +The [communication](communication.md) page lists communication channels like chat, |
| 21 | +issues, mailing lists, meetings, conferences, etc. |
| 22 | + |
| 23 | +## Assets |
| 24 | + |
| 25 | +- Helm logos are located at [cncf/artwork](https://github.com/cncf/artwork/blob/master/examples/graduated.md#helm-logos) |
| 26 | +- Helm website and docs are located at [helm/helm-www](https://github.com/helm/helm-www) |
| 27 | +- Helm brand examples and guidelines: [art](/community/art) |
| 28 | +- Helm themed presentation template: [slides](https://github.com/helm/community/tree/main/slides) |
| 29 | + |
| 30 | +## How Can I Help? |
| 31 | + |
| 32 | +#### First, you should join our communication forums: |
| 33 | + |
| 34 | +- Follow us on [Twitter](communication.md#social-media) |
| 35 | +- Join us on [Slack](communication.md#slack) |
| 36 | +- Subscribe to our [mailing lists](communication.md#mailing-lists) |
| 37 | +- Join the [weekly meeting](communication.md#meetings) |
| 38 | + |
| 39 | +#### Next, get set-up with the basics (if not already done so): |
| 40 | + |
| 41 | +- [Documentation](https://docs.helm.sh/) |
| 42 | +- [Issues](https://github.com/helm/helm/issues) |
| 43 | +- [PRs](https://github.com/helm/helm/pulls) |
| 44 | +- [Quickstart Guide](https://docs.helm.sh/using_helm/#quickstart) |
| 45 | +- [Developer Guide](https://docs.helm.sh/developers/) |
| 46 | + |
| 47 | +Now, you can get down to business! |
| 48 | + |
| 49 | +A good way to learn is: |
| 50 | + |
| 51 | +- Check out the code and look at code reviews. Documentation and test are part of the code base. |
| 52 | +- Try reproducing issues and get an overview of user problems. |
| 53 | +- Talk to people on Slack and ask questions. |
| 54 | + |
| 55 | +Areas you can start working on: |
| 56 | + |
| 57 | +- Documentation (like the text you are reading now) can always use improvement! |
| 58 | +- We can always do with more test coverage. |
| 59 | +- Review open PRs. Add comments, feedback or give a LGTM! |
| 60 | +- Try out some easy-to-fix bugs which may be marked with the [good first issue] tag |
| 61 | +- Just ask an [owner] for suggestions. |
| 62 | + |
| 63 | +#### Last but not least, we'd love to know what you want to see on the [Helm Blog](https://helm.sh/blog). |
| 64 | +Feel free to submit a blog post topic [here](blog-topics.md). |
| 65 | + |
| 66 | +## Your First Contribution |
| 67 | + |
| 68 | +We recommend that you work on existing [issues] before attempting to develop a new feature. |
| 69 | + |
| 70 | +Find an existing issue (e.g. one marked [good first issue], or simply ask an [owner] for suggestions), |
| 71 | +and respond on the issue thread expressing interest in working on it. |
| 72 | + |
| 73 | +This helps other people know that the issue is active, and hopefully prevents duplicated efforts. |
| 74 | + |
| 75 | +Each commit must be signed off in git, as described by |
| 76 | +[the article](https://www.helm.sh/blog/helm-dco/index.html) |
| 77 | +describing Helm's switch to DCO. |
| 78 | + |
| 79 | +If you want to work on a new idea of relatively small scope: |
| 80 | + |
| 81 | + 1. Submit an issue describing your proposed change to the repo in question. |
| 82 | + 1. The repo owners will respond to your issue promptly. |
| 83 | + 1. If your proposed change is accepted, start work in your fork, signing off each commit as described above. |
| 84 | + 1. Submit a [pull request] containing a tested change. |
| 85 | + |
| 86 | + |
| 87 | +[good first issue]: https://github.com/helm/helm/issues?utf8=%E2%9C%93&q=is%3Aopen%20is%3Aissue%20label%3A%22good+first+issue%22 |
| 88 | +[issues]: https://github.com/helm/helm/issues |
| 89 | +[pull request]: https://github.com/helm/helm/blob/main/CONTRIBUTING.md#pull-requests |
| 90 | +[owner]: https://github.com/kubernetes/helm/blob/main/OWNERS |
0 commit comments