Skip to content

Commit e2e02f5

Browse files
richardcaserichardcase
authored
Community docs (#162)
Added documents to the repo that people generally expect from a OSS project.
1 parent b5f183c commit e2e02f5

8 files changed

+257
-2
lines changed

‎.github/ISSUE_TEMPLATE.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!--
2+
Hi, thank you for opening an issue!
3+
Before hitting the button...
4+
5+
** Is this a REQUEST FOR HELP? **
6+
If so, please search existing issues (open & closed) to see if there is a similar one. If there is add comments or vote where appropriate. List of issues are here: https://github.com/weaveworks/eksctl/issues?utf8=%E2%9C%93&q=is%3Aissue
7+
If you did not find a similar issue or if it did not help then:
8+
- ask for help in our slack channel: https://weave-community.slack.com/messages/eksctl/
9+
10+
** Is this a FEATURE REQUEST? **
11+
If so, please search existing feature requests, and if you find a similar one, up-vote it and/or add your comments to it instead.
12+
If you did not find a similar one, please describe in details:
13+
- why: your use-case, specific constraints you may have, etc.
14+
- what: the feature/behaviour/change you would like to see in eksctl
15+
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".
16+
17+
** Is this a BUG REPORT? **
18+
Please fill in as much of the template below as you can.
19+
20+
Thank you!
21+
-->
22+
23+
## What you expected to happen?
24+
25+
## What happened?
26+
<!-- Error message, actual behaviour, etc. -->
27+
28+
## How to reproduce it?
29+
<!-- Specific steps, as minimally and precisely as possible. -->
30+
31+
## Anything else we need to know?
32+
<!-- Hardware? OS? -->
33+
34+
## Versions:
35+
<!-- Please paste in the output of these commands; -->
36+
```
37+
$ eksctl version
38+
$ uname -a
39+
$ kubectl version
40+
```
41+
Also include your version of `heptio-authenticator-aws`
42+
43+
## Logs:
44+
Include the output of the command line when running eksctl. If possible, eksctl should be run with debug logs. For example:
45+
`eksctl get clusters -v 4`
46+
Make sure you redact any sensitive information before posting.
47+
48+
<!-- (If output is long, please consider a Gist.) -->

‎.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
### Description
2+
Please explain the changes you made here.
3+
4+
### Checklist
5+
- [ ] Code compiles correctly (i.e `make build`)
6+
- [ ] Added tests that cover your change (if possible)
7+
- [ ] All tests passing (i.e. `make tests`)
8+
- [ ] Added/modified documentation as required (such as the README)
9+
- [ ] Added yourself to the humans.txt file

‎CODE-OF-CONDUCT.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Community Code of Conduct
2+
3+
Eksctl follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
4+
5+
Instances of abusive, harassing, or otherwise unacceptable behavior
6+
may be reported by contacting a *eksctl* project maintainer, or
7+
Alexis Richardson <[email protected]>.

‎CONTRIBUTING.md

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# How to Contribute
2+
3+
*eksctl* is [Apache 2.0 licenced](LICENSE) and accepts contributions via GitHub
4+
pull requests. This document outlines some of the conventions on the development
5+
workflow, commit message formatting, contact points and other resources to make
6+
it easier to get your contribution accepted.
7+
8+
We gratefully welcome improvements to documentation as well as to code.
9+
10+
# Certificate of Origin
11+
12+
By contributing to this project you agree to the Developer Certificate of
13+
Origin (DCO). This document was created by the Linux Kernel community and is a
14+
simple statement that you, as a contributor, have the legal right to make the
15+
contribution. No action from you is required, but it's a good idea to see the
16+
[DCO](DCO) file for details before you start contributing code to eksctl.
17+
18+
# Chat
19+
20+
The project uses Slack. If you get stuck or just have a question then you are encouraged to join the [Weave Community](https://weaveworks.github.io/community-slack/) Slack workspace and use the [#eksctl](https://weave-community.slack.com/messages/eksctl/) channel.
21+
22+
## Getting Started
23+
24+
- Fork the repository on GitHub
25+
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
26+
- If you want to contribute as a developer, continue reading this document for further instructions
27+
- Play with the project, submit bugs, submit pull requests!
28+
29+
## Contribution workflow
30+
31+
This is a rough outline of how to prepare a contribution:
32+
33+
- Find an [issue](https://github.com/weaveworks/eksctl/issues) to work on. If you are a new contributer
34+
take a look at issues marked with [good first issue](https://github.com/weaveworks/eksctl/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
35+
- Create a topic branch from where you want to base your work (usually branched from master).
36+
- Make commits of logical units.
37+
- Make sure your commit messages are in the proper format (see below).
38+
- Push your changes to a topic branch in your fork of the repository.
39+
- If you changed code:
40+
- add automated tests to cover your changes. See the [az](https://github.com/weaveworks/eksctl/tree/master/pkg/az) package for a good example of tests.
41+
- Submit a pull request to the original repository.
42+
43+
If your PR is a work in progress then make sure you prefix the title with `WIP: `. This lets everyone know that this is still being worked on. Once its ready
44+
remove the `WIP: ` title prefix and where possible squash your commits.
45+
46+
## How to build and run the project
47+
48+
```bash
49+
make build
50+
./eksctl get clusters
51+
```
52+
53+
## How to run the test suite
54+
55+
You can run the unit tests by simply doing
56+
57+
```bash
58+
make tests
59+
```
60+
61+
There are integration tests for *eksctl* being developed and more details of how to run them will be included here. You can follow the progress [here](https://github.com/weaveworks/eksctl/issues/151).
62+
63+
# Acceptance policy
64+
65+
These things will make a PR more likely to be accepted:
66+
67+
* a well-described requirement
68+
* tests for new code
69+
* tests for old code!
70+
* new code and tests follow the conventions in old code and tests
71+
* a good commit message (see below)
72+
73+
In general, we will merge a PR once a maintainer has reviewed and approved it.
74+
Trivial changes (e.g., corrections to spelling) may get waved through.
75+
For substantial changes, more people may become involved, and you might get asked to resubmit the PR or divide the changes into more than one PR.
76+
77+
### Format of the Commit Message
78+
79+
We follow a rough convention for commit messages that is designed to answer two
80+
questions: what changed and why. The subject line should feature the what and
81+
the body of the commit should describe the why.
82+
83+
```
84+
Added AWS Profile Support
85+
86+
Changes to ensure that AWS profiles are supported. This involved making
87+
sure that the AWS config file is loaded (SharedConfigEnabled) and
88+
also making sure we have a TokenProvider set.
89+
90+
Added an explicit --profile flag that can be used to explicity specify
91+
which AWS profile you would like to use. This will override any profile
92+
that you have specified via AWS_PROFILE.
93+
94+
If endpoints are being overriden then the credentials from the initial
95+
session creation are shared with any subsequent session creation to
96+
ensure that the tokens are shared (otherwise you may get multiple MFA
97+
prompts).
98+
99+
Issue #57
100+
```
101+
102+
The format can be described more formally as follows:
103+
104+
```
105+
<short title for what changed>
106+
<BLANK LINE>
107+
<why this change was made and what changed>
108+
<BLANK LINE>
109+
<footer>
110+
```
111+
112+
The first line is the subject and should be no longer than 70 characters, the
113+
second line is always blank, and other lines should be wrapped at 80 characters.
114+
This allows the message to be easier to read on GitHub as well as in various git tools.
115+

‎DCO

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
660 York Street, Suite 102,
6+
San Francisco, CA 94110 USA
7+
8+
Everyone is permitted to copy and distribute verbatim copies of this
9+
license document, but changing it is not allowed.
10+
11+
12+
Developer's Certificate of Origin 1.1
13+
14+
By making a contribution to this project, I certify that:
15+
16+
(a) The contribution was created in whole or in part by me and I
17+
have the right to submit it under the open source license
18+
indicated in the file; or
19+
20+
(b) The contribution is based upon previous work that, to the best
21+
of my knowledge, is covered under an appropriate open source
22+
license and I have the right under that license to submit that
23+
work with modifications, whether created in whole or in part
24+
by me, under the same open source license (unless I am
25+
permitted to submit under a different license), as indicated
26+
in the file; or
27+
28+
(c) The contribution was provided directly to me by some other
29+
person who certified (a), (b) or (c) and I have not modified
30+
it.
31+
32+
(d) I understand and agree that this project and the contribution
33+
are public and that a record of the contribution (including all
34+
personal information I submit with it, including my sign-off) is
35+
maintained indefinitely and may be redistributed consistent with
36+
this project or the open source license(s) involved.

‎OWNERS

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
approvers:
2+
- errordeveloper
3+
reviewers:
4+
- richardcase
5+
- christopherhein
6+
- jstrachan
7+
- stefanprodan

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `eksctl` - a CLI for Amazon EKS
22

3-
[![Circle CI](https://circleci.com/gh/weaveworks/eksctl/tree/master.svg?style=shield)](https://circleci.com/gh/weaveworks/eksctl/tree/master) [![Coverage Status](https://coveralls.io/repos/github/weaveworks/eksctl/badge.svg?branch=master)](https://coveralls.io/github/weaveworks/eksctl?branch=master)
3+
[![Circle CI](https://circleci.com/gh/weaveworks/eksctl/tree/master.svg?style=shield)](https://circleci.com/gh/weaveworks/eksctl/tree/master) [![Coverage Status](https://coveralls.io/repos/github/weaveworks/eksctl/badge.svg?branch=master)](https://coveralls.io/github/weaveworks/eksctl?branch=master)[![Go Report Card](https://goreportcard.com/badge/github.com/weaveworks/eksctl)](https://goreportcard.com/report/github.com/weaveworks/eksctl)
44

55
`eksctl` is a simple CLI tool for creating clusters on EKS - Amazon's new managed Kubernetes service for EC2. It is written in Go, and based on Amazon's official CloudFormation templates.
66

@@ -182,7 +182,7 @@ And `eksctld` will be a controller inside of one cluster that can manage multipl
182182

183183
## Contributions
184184

185-
Code contributions are very welcome, however until a 0.1.0 release testing and bug reports are the contributions that authors will appreciate the most.
185+
Code contributions are very welcome. If you are interested in helping make eksctl great then see our [contributing guide](CONTRIBUTING.md).
186186

187187
## Get in touch
188188

‎humans.txt

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
_ _ _
2+
| | | | | |
3+
___ | | __ ___ ___ | |_ | |
4+
/ _ \| |/ // __| / __|| __|| |
5+
| __/| < \__ \| (__ | |_ | |
6+
\___||_|\_\|___/ \___| \__||_|
7+
8+
Making working with EKS easy since 2018
9+
10+
/* Humans */
11+
12+
Ilya Dmitrichenko @errordeveloper maintainer & chief
13+
Richard Case @richardcase
14+
Christopher Hein @christopherhein
15+
Matthias Radestock @rade
16+
Archis @archisgore
17+
Stefan Prodan @stefanprodan
18+
James Strachan @jstrachan
19+
Nick @bowlesns
20+
21+
/* Thanks */
22+
23+
Thanks to all the other contributers and users of eksctl. Without you we can't make it great.
24+
25+
/* Site */
26+
27+
Last update: -
28+
Language: English
29+
Doctype: HTML5
30+
IDE: VIM/VsCode/Atom
31+
Generator: Jekyll (Ruby)
32+
SCM: Git
33+
Hosting: GitHub

0 commit comments

Comments
 (0)