forked from eksctl-io/eksctl
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documents to the repo that people generally expect from a OSS project.
- Loading branch information
1 parent
b5f183c
commit e2e02f5
Showing
8 changed files
with
257 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<!-- | ||
Hi, thank you for opening an issue! | ||
Before hitting the button... | ||
** Is this a REQUEST FOR HELP? ** | ||
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 | ||
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/ | ||
** Is this a FEATURE REQUEST? ** | ||
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. | ||
If you did not find a similar one, please describe in details: | ||
- why: your use-case, specific constraints you may have, etc. | ||
- what: the feature/behaviour/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". | ||
** Is this a BUG REPORT? ** | ||
Please fill in as much of the template below as you can. | ||
Thank you! | ||
--> | ||
|
||
## What you expected to happen? | ||
|
||
## What happened? | ||
<!-- Error message, actual behaviour, etc. --> | ||
|
||
## How to reproduce it? | ||
<!-- Specific steps, as minimally and precisely as possible. --> | ||
|
||
## Anything else we need to know? | ||
<!-- Hardware? OS? --> | ||
|
||
## Versions: | ||
<!-- Please paste in the output of these commands; --> | ||
``` | ||
$ eksctl version | ||
$ uname -a | ||
$ kubectl version | ||
``` | ||
Also include your version of `heptio-authenticator-aws` | ||
|
||
## 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 output is long, please consider a Gist.) --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
### Description | ||
Please explain the changes you made here. | ||
|
||
### Checklist | ||
- [ ] Code compiles correctly (i.e `make build`) | ||
- [ ] Added tests that cover your change (if possible) | ||
- [ ] All tests passing (i.e. `make tests`) | ||
- [ ] Added/modified documentation as required (such as the README) | ||
- [ ] Added yourself to the humans.txt file |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
## Community Code of Conduct | ||
|
||
Eksctl follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior | ||
may be reported by contacting a *eksctl* project maintainer, or | ||
Alexis Richardson <[email protected]>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# How to Contribute | ||
|
||
*eksctl* is [Apache 2.0 licenced](LICENSE) and accepts contributions via GitHub | ||
pull requests. This document outlines some of the conventions on the development | ||
workflow, commit message formatting, contact points and other resources to make | ||
it easier to get your contribution accepted. | ||
|
||
We gratefully welcome improvements to documentation as well as to code. | ||
|
||
# Certificate of Origin | ||
|
||
By contributing to this project you agree to the Developer Certificate of | ||
Origin (DCO). This document was created by the Linux Kernel community and is a | ||
simple statement that you, as a contributor, have the legal right to make the | ||
contribution. No action from you is required, but it's a good idea to see the | ||
[DCO](DCO) file for details before you start contributing code to eksctl. | ||
|
||
# Chat | ||
|
||
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. | ||
|
||
## Getting Started | ||
|
||
- Fork the repository on GitHub | ||
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help | ||
- If you want to contribute as a developer, continue reading this document for further instructions | ||
- Play with the project, submit bugs, submit pull requests! | ||
|
||
## Contribution workflow | ||
|
||
This is a rough outline of how to prepare a contribution: | ||
|
||
- Find an [issue](https://github.com/weaveworks/eksctl/issues) to work on. If you are a new contributer | ||
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). | ||
- Create a topic branch from where you want to base your work (usually branched from master). | ||
- Make commits of logical units. | ||
- Make sure your commit messages are in the proper format (see below). | ||
- Push your changes to a topic branch in your fork of the repository. | ||
- If you changed code: | ||
- 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. | ||
- Submit a pull request to the original repository. | ||
|
||
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 | ||
remove the `WIP: ` title prefix and where possible squash your commits. | ||
|
||
## How to build and run the project | ||
|
||
```bash | ||
make build | ||
./eksctl get clusters | ||
``` | ||
|
||
## How to run the test suite | ||
|
||
You can run the unit tests by simply doing | ||
|
||
```bash | ||
make tests | ||
``` | ||
|
||
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). | ||
|
||
# Acceptance policy | ||
|
||
These things will make a PR more likely to be accepted: | ||
|
||
* a well-described requirement | ||
* tests for new code | ||
* tests for old code! | ||
* new code and tests follow the conventions in old code and tests | ||
* a good commit message (see below) | ||
|
||
In general, we will merge a PR once a maintainer has reviewed and approved it. | ||
Trivial changes (e.g., corrections to spelling) may get waved through. | ||
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. | ||
|
||
### Format of the Commit Message | ||
|
||
We follow a rough convention for commit messages that is designed to answer two | ||
questions: what changed and why. The subject line should feature the what and | ||
the body of the commit should describe the why. | ||
|
||
``` | ||
Added AWS Profile Support | ||
Changes to ensure that AWS profiles are supported. This involved making | ||
sure that the AWS config file is loaded (SharedConfigEnabled) and | ||
also making sure we have a TokenProvider set. | ||
Added an explicit --profile flag that can be used to explicity specify | ||
which AWS profile you would like to use. This will override any profile | ||
that you have specified via AWS_PROFILE. | ||
If endpoints are being overriden then the credentials from the initial | ||
session creation are shared with any subsequent session creation to | ||
ensure that the tokens are shared (otherwise you may get multiple MFA | ||
prompts). | ||
Issue #57 | ||
``` | ||
|
||
The format can be described more formally as follows: | ||
|
||
``` | ||
<short title for what changed> | ||
<BLANK LINE> | ||
<why this change was made and what changed> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
|
||
The first line is the subject and should be no longer than 70 characters, the | ||
second line is always blank, and other lines should be wrapped at 80 characters. | ||
This allows the message to be easier to read on GitHub as well as in various git tools. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
|
||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
|
||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
approvers: | ||
- errordeveloper | ||
reviewers: | ||
- richardcase | ||
- christopherhein | ||
- jstrachan | ||
- stefanprodan |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
_ _ _ | ||
| | | | | | | ||
___ | | __ ___ ___ | |_ | | | ||
/ _ \| |/ // __| / __|| __|| | | ||
| __/| < \__ \| (__ | |_ | | | ||
\___||_|\_\|___/ \___| \__||_| | ||
|
||
Making working with EKS easy since 2018 | ||
|
||
/* Humans */ | ||
|
||
Ilya Dmitrichenko @errordeveloper maintainer & chief | ||
Richard Case @richardcase | ||
Christopher Hein @christopherhein | ||
Matthias Radestock @rade | ||
Archis @archisgore | ||
Stefan Prodan @stefanprodan | ||
James Strachan @jstrachan | ||
Nick @bowlesns | ||
|
||
/* Thanks */ | ||
|
||
Thanks to all the other contributers and users of eksctl. Without you we can't make it great. | ||
|
||
/* Site */ | ||
|
||
Last update: - | ||
Language: English | ||
Doctype: HTML5 | ||
IDE: VIM/VsCode/Atom | ||
Generator: Jekyll (Ruby) | ||
SCM: Git | ||
Hosting: GitHub |