Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-write Contributing docs #3022

Merged
merged 5 commits into from
Jan 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 39 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,55 @@ assignees: ''

---

**What happened?**
A description of actual behavior (with error messages).
<!--
Thank you for opening this bug report! You are helping make eksctl a better project :)
In order to help us process this issue faster, please provide as much detail as possible.

When providing command examples, error output or code samples, please use code blocks.
For verbose output, for example logs, please either create a gist or use html details tags.
-->

<!--
Before you start writing, please search through existing issues to see whether your problem has already been reported.
For more information on how to open a bug report in eksctl, please refer to our issue submission guide.
https://github.com/weaveworks/eksctl/blob/master/CONTRIBUTING.md#opening-issues
-->

**What were you trying to accomplish?**
<!-- Information about the command you ran and what you expected to happen. -->

**What you expected to happen?**
A clear and concise description of what the bug is.
**What happened?**
<!-- A description of actual behavior (with error messages). -->

**How to reproduce it?**
Include the steps to reproduce the bug.
If using a config, include it here, removing any sensitive information!
<!--
Include ALL the steps to reproduce the bug.

If using a config file, include it here, removing any sensitive information!
-->


**Logs**
<!--
Include the output of the command line when running eksctl. If possible, eksctl should be run with debug logs. For example:
`eksctl get clusters -v 4`
Make sure you redact any sensitive information before posting.
If the output is long, please consider a Gist, or an html details tag.
-->

**Anything else we need to know?**
What OS are you using, are you using a downloaded binary or did you compile eksctl, what type of AWS credentials are you using (i.e. default/named profile, MFA) - please don't include actual credentials though!
<!--
What OS are you using?
Are you using a downloaded binary or did you compile eksctl?
What type of AWS credentials are you using (i.e. default/named profile, MFA)? - please don't include actual credentials though!
-->

**Versions**
<!--
Please paste in the output of these commands:
-->
```
$ eksctl version
$ kubectl version
```

**Logs**
Include the output of the command line when running eksctl. If possible, eksctl should be run with debug logs. For example:
`eksctl get clusters -v 4`
Make sure you redact any sensitive information before posting.
If the output is long, please consider a Gist.
23 changes: 19 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,27 @@ assignees: ''

---

*Before creating a feature request, please search existing feature requests to see if you find a similar one. If there is a similar feature request please up-vote it and/or add your comments to it instead*
<!--
Thank you for opening this feature request! You are helping make eksctl a better project :)
In order to help us process this request faster, please provide as much detail as possible.

**Why do you want this feature?**
A clear and concise description of why you want this feature. Include use-cases and any specific constraints you may have.
Before creating a feature request, please search existing issues to see if this request has already been made. If there is a similar feature request please up-vote it and/or add your comments to it instead.

For more information on how to contribute to eksctl, please refer to our contributing docs.
https://github.com/weaveworks/eksctl/blob/master/CONTRIBUTING.md#opening-issues
-->

**What feature/behavior/change do you want?**
Callisto13 marked this conversation as resolved.
Show resolved Hide resolved
<!--
A clear and concise description of the change you would like to see in eksctl.

Do not hesitate, when appropriate, to share the exact commands or API you would like, and/or to share a diagram (e.g.: asciiflow.com): "a picture is worth a thousand words".
Do not hesitate, when appropriate, to share the exact commands or API you would like,
and/or to share a diagram (e.g.: asciiflow.com): "a picture is worth a thousand words".
-->

**Why do you want this feature?**
<!--
A clear and concise description of why you want this feature.
What is it you are trying to accomplish?
Include use-cases and any specific constraints you may have.
-->
21 changes: 17 additions & 4 deletions .github/ISSUE_TEMPLATE/request-for-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,23 @@ assignees: ''

---

Please [search existing issues (open & closed)](https://github.com/weaveworks/eksctl/issues?utf8=%E2%9C%93&q=is%3Aissue) to see if there is a similar one. If there is, add comments or vote where appropriate.
<!--
In order to help us process this issue faster, please provide as much detail as possible.

If you did not find a similar issue or if it did not help then ask for help in our [slack channel](https://weave-community.slack.com/messages/eksctl/)
Before creating a new request for help, please search existing issue to see if you find a similar one.
If there is a similar feature request please up-vote it and/or add your comments to it instead

For more information on how to request help on eksctl, please refer to our community docs.
https://github.com/weaveworks/eksctl/blob/master/CONTRIBUTING.md#opening-issues
-->

**What help do you need?**
Describe the type of help you need.
Please include your config, removing any sensitive information, or exact commands you're using.
<!--
Explain what you are trying to accomplish, what you have tried, and the behaviour you are seeing.

When providing any output or code/config samples, please use code blocks.

Please include your config, removing any sensitive information, or exact the commands you're using.

When providing verbose logs, please use either a gist or html detail tags.
-->
18 changes: 15 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
### Description

<!-- Please explain the changes you made here. -->
<!--
Please explain the changes you made here.

Help your reviewers my guiding them through your key changes,
implementation decisions etc.
You can even include snippets of output or screenshots.

A good, clear description == a faster review :)
-->

### Checklist
- [ ] Added tests that cover your change (if possible)
- [ ] Added/modified documentation as required (such as the `README.md`, or the `userdocs` directory)
- [ ] Manually tested
- [ ] Added labels for change area (e.g. `area/nodegroup`), target version (e.g. `version/0.12.0`) and kind (e.g. `kind/improvement`)
- [ ] Make sure the title of the PR is a good description that can go into the release notes
- [ ] Made sure the title of the PR is a good description that can go into the release notes
- [ ] (Core team) Added labels for change area (e.g. `area/nodegroup`), target version (e.g. `version/0.12.0`) and kind (e.g. `kind/improvement`)

### BONUS POINTS checklist: complete for good vibes and maybe prizes?! :exploding_head:
- [ ] Backfilled missing tests for code in same general area :tada:
- [ ] Refactored something and made the world a better place :star2:

62 changes: 62 additions & 0 deletions COMMUNITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# eksctl community

Welcome to the eksctl community. We are very happy to have you here :tada: .

This document contains the following information:

- [Who the core team members are](#core-team)
- [How to join the community](#join-us) and get in touch with the core team
- [How eksctl is run](#how-eksctl-is-run) and how decisions are made
- [Community meetings](#community-meetings)
- [Community rules](#community-rules)

Ready to start contributing? Head over to our [contribution docs](CONTRIBUTING.md) :man_technologist:.

## Core team

The core team of maintainers are Mike Beaumont ([@michaelbeaumont](https://github.com/michaelbeaumont)),
Chetan Patwal ([@cPu1](https://github.com/cPu1)),
Jake Klein ([@aclevername](https://github.com/aclevername))
and Claudia Beresford ([@Callisto13](https://github.com/Callisto13)).

## Join us!

The project uses Slack. If you get stuck or just have a question then you are encouraged to join the
[Weave Community](https://slack.weave.works/) Slack workspace and use the
[#eksctl](https://weave-community.slack.com/messages/eksctl/) channel and/or the [mailing
list][maillist].

We use the mailing list for some discussion, for sharing documents and for calendar invites.

[maillist]: https://groups.google.com/forum/#!forum/eksctl

## How eksctl is run

Eksctl is an open-source project built to interact with a closed-source product.
This means that 99% of the project operates like any other open-source one,
with 1% of things happening in slightly secretive fashion as the maintainers
work with the folks at Amazon to synchronise the release of cool new EKS stuff :sunglasses: .

For that 99%, we strive to keep development open, and transparent.
Work is driven through partnership with AWS and the needs of the community.
We welcome all contributions and user feedback to the project.

**The roles in the eksctl community are as follows:**
- End users. In other words the reason why we are all here!
- Community contributors. These could be end users themselves, or those working
on their open-source game.
- Maintainers. See [the maintainer docs](link coming soon before I merge) for a list
of maintainer responsibilities.

Decisions are made by Maintainers with input from both Amazon and the community.
All the decisions which can be made publicly will take into account the opinions
of all in the community with sufficient opportunity given for those interested
to get involved.

## Community meetings

_A new schedule and format for community meetings is being worked out... watch this space! :space_invader: :eyes:_

## Community rules

The main one is **Always be kind**, and the rest can be found in our [Code of Conduct](CODE_OF_CONDUCT.md).
Loading