From 5fcf3aa52af55a72772ba53942ae10c06350d0df Mon Sep 17 00:00:00 2001 From: Matt Briggs Date: Mon, 21 Dec 2020 11:27:26 -0800 Subject: [PATCH] project setup README, licenses, templates, gitignore. --- .github/ISSUE_TEMPLATE/feature.md | 17 +++++++++++++++++ .github/pull_request_template.md | 21 +++++++++++++++++++++ .gitignore | 4 ++++ CONTRIBUTING.md | 2 +- LICENSE => LICENSE-APACHE | 0 LICENSE-MIT | 8 ++++++++ README.md | 13 +++++-------- 7 files changed, 56 insertions(+), 9 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/pull_request_template.md create mode 100644 .gitignore rename LICENSE => LICENSE-APACHE (100%) create mode 100644 LICENSE-MIT diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..4641e22 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Request a change to to the project +--- + + + +**What I'd like:** + + + +**Any alternatives you've considered:** + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ef6d9a1 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,21 @@ + + +**Issue number:** + + + +**Description of changes:** + + + +**Testing done:** + + + +**Terms of contribution:** + +By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..04f6ca5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*.env +/.idea +/integ/target +/updater/target \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4b6a1c..3481301 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,4 +56,4 @@ If you discover a potential security issue in this project we ask that you notif ## Licensing -See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +See the [LICENSE-APACHE](LICENSE-APACHE) or [LICENSE-MIT](LICENSE-MIT) file for our project's licensing. We will ask you to confirm the licensing of your contribution. diff --git a/LICENSE b/LICENSE-APACHE similarity index 100% rename from LICENSE rename to LICENSE-APACHE diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..df3c0d6 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,8 @@ +MIT License +Copyright Amazon.com, Inc., its affiliates, or other contributors. All Rights Reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 847260c..987503b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,8 @@ -## My Project +# Bottlerocket ECS Updater -TODO: Fill this README out! - -Be sure to: - -* Change the title in this README -* Edit your repository description on GitHub +This project is a work-in-progress, currently unreleased. +The purpose of this project is to provide a deployable system that will monitor and update Bottlerocket instances in an ECS cluster. +See issue #1 for a description of the MVP design. ## Security @@ -13,5 +10,5 @@ See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more inform ## License -This project is licensed under the Apache-2.0 License. +This project is dual licensed under either the Apache-2.0 License or the MIT license, your choice.