From 5b91742d76160cebeef63422f5ecbc9e8bf68387 Mon Sep 17 00:00:00 2001 From: anishapm Date: Mon, 29 Jul 2024 14:44:11 +0100 Subject: [PATCH 1/3] Update template and contributing --- CONTRIBUTING.md | 71 +++++++++++++++++++++++++++++++------------ PULL_REQUEST_TEMPLATE | 16 ++++++++-- 2 files changed, 65 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ac3edd..d4e062f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,9 @@ documentation, we greatly value feedback and contributions from our community. Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution. - ## Security issue notifications -If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. +If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. ## Reporting Bugs/Feature Requests @@ -18,42 +17,74 @@ We welcome you to use the GitHub issue tracker to report bugs or suggest feature When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: -* A reproducible test case or series of steps -* The version of our code being used -* Any modifications you've made relevant to the bug -* Anything unusual about your environment or deployment - +- A reproducible test case or series of steps +- The version of our code being used +- Any modifications you've made relevant to the bug +- Anything unusual about your environment or deployment ## Contributing via Pull Requests + Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: -1. You are working against the latest source on the *main* branch. +1. You are working against the latest source on the _main_ branch. 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. 3. You open an issue to discuss any significant work - we would hate for your time to be wasted. -To send us a pull request, please: +#### Making major changes (e.g. new features) -1. Fork the repository. -2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change. -3. Ensure local tests pass. -4. Commit to your fork using clear commit messages. -5. Send us a pull request, answering any default questions in the pull request interface. -6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation. +1. Fork the public AmazonAppDev repo to your GitHub account. +2. Clone your fork locally: -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). +``` +git clone https://github.com/your-username/repo-name.git +``` + +3. Create a new branch for your changes e.g. left-hand-navigation-drawer + +``` +git checkout -b your-feature-branch +``` + +4. Make changes, test, commit, and push to your fork: +``` +git add . +git commit -m "Clear commit message" +git push origin your-feature-branch +``` -## Finding contributions to work on -Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start. +4. Create a pull request from your branch to the original repo using the feature template. +5. After approval, the original repo maintainer shall merge your changes. +6. Update your fork's main branch +#### Making bug fixes + +1. Create an issue in the repo describing the bug +2. Create a fix branch locally from the main repo: + +``` +git checkout -b fix/issue-number-description +``` + +3. Make changes and once finished commit to your branch + +``` +git push origin fix/issue-number-description +``` + +4. Create a pull request linking to the issue use the fix template. +5. After approval, squash merge the fix +6. Delete the fix branch + +GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and +[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). ## Code of Conduct + This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact opensource-codeofconduct@amazon.com with any additional questions or comments. - ## Licensing See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution. diff --git a/PULL_REQUEST_TEMPLATE b/PULL_REQUEST_TEMPLATE index 6bdaa99..906cf25 100644 --- a/PULL_REQUEST_TEMPLATE +++ b/PULL_REQUEST_TEMPLATE @@ -1,6 +1,18 @@ -*Issue #, if available:* +**Feature:** [Name of the new feature] +This PR implements [brief description of the feature -*Description of changes:* +or +**Fix:** [Brief description of the bug] +This PR addresses issue #[issue number] + +**Changes:** +[List main changes made] +[Mention any new dependencies or tools] + +**Testing:** +[Describe how the change was tested] + +[Any additional notes or questions for reviewers] By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. From dd87cf52986f493cef5ce68150a4d988f7ac6580 Mon Sep 17 00:00:00 2001 From: anishapm Date: Thu, 8 Aug 2024 17:25:07 +0100 Subject: [PATCH 2/3] Update templates --- CONTRIBUTING.md | 75 ++++++++----------------------------------- PULL_REQUEST_TEMPLATE | 2 +- 2 files changed, 15 insertions(+), 62 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4e062f..87013a6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,54 +10,21 @@ information to effectively respond to your bug report or contribution. If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue. -## Reporting Bugs/Feature Requests +## Submitting a PR -We welcome you to use the GitHub issue tracker to report bugs or suggest features. - -When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already -reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: - -- A reproducible test case or series of steps -- The version of our code being used -- Any modifications you've made relevant to the bug -- Anything unusual about your environment or deployment - -## Contributing via Pull Requests - -Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: - -1. You are working against the latest source on the _main_ branch. -2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. -3. You open an issue to discuss any significant work - we would hate for your time to be wasted. - -#### Making major changes (e.g. new features) - -1. Fork the public AmazonAppDev repo to your GitHub account. -2. Clone your fork locally: - -``` -git clone https://github.com/your-username/repo-name.git -``` - -3. Create a new branch for your changes e.g. left-hand-navigation-drawer +1. Fork the public AmazonAppDev repo to your GitHub account +2. We recommend creating a new branch in your fork to keep track of your changes e.g. `left-hand-navigation-drawer` +3. Make your changes, test, commit, and push to your fork +4. Create a pull request from your branch to the original repo. After approval, the original repo maintainer shall merge your changes +5. Remember to update your fork's main branch ``` -git checkout -b your-feature-branch +git checkout main +git pull upstream main +git push origin main ``` -4. Make changes, test, commit, and push to your fork: - -``` -git add . -git commit -m "Clear commit message" -git push origin your-feature-branch -``` - -4. Create a pull request from your branch to the original repo using the feature template. -5. After approval, the original repo maintainer shall merge your changes. -6. Update your fork's main branch - -#### Making bug fixes +## (If you have commit access) Making bug fixes 1. Create an issue in the repo describing the bug 2. Create a fix branch locally from the main repo: @@ -66,24 +33,10 @@ git push origin your-feature-branch git checkout -b fix/issue-number-description ``` -3. Make changes and once finished commit to your branch - -``` -git push origin fix/issue-number-description -``` - -4. Create a pull request linking to the issue use the fix template. -5. After approval, squash merge the fix -6. Delete the fix branch - -GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and -[creating a pull request](https://help.github.com/articles/creating-a-pull-request/). - -## Code of Conduct - -This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). -For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact -opensource-codeofconduct@amazon.com with any additional questions or comments. +1. Make changes and once finished commit to your branch +2. Create a pull request linking to the issue +3. After approval, squash merge the fix +4. Delete the fix branch ## Licensing diff --git a/PULL_REQUEST_TEMPLATE b/PULL_REQUEST_TEMPLATE index 906cf25..c68fc99 100644 --- a/PULL_REQUEST_TEMPLATE +++ b/PULL_REQUEST_TEMPLATE @@ -1,5 +1,5 @@ **Feature:** [Name of the new feature] -This PR implements [brief description of the feature +This PR implements [brief description of the feature] or From 073027edc934e85e22780bb17e7152f353ba130b Mon Sep 17 00:00:00 2001 From: Fnu Aimi Date: Fri, 18 Oct 2024 15:20:43 -0700 Subject: [PATCH 3/3] Update SECURITY.md --- SECURITY.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/SECURITY.md b/SECURITY.md index 75a3b51..929cbfa 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,11 +1,11 @@ ## Reporting Security Issues -We take all security reports seriously. -When we receive such reports, -we will investigate and subsequently address -any potential vulnerabilities as quickly as possible. -If you discover a potential security issue in this project, -please notify AWS/Amazon Security via our -[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) -or directly via email to [AWS Security](mailto:aws-security@amazon.com). -Please do *not* create a public GitHub issue in this project. +Amazon Web Services (AWS) is dedicated to the responsible disclosure of security vulnerabilities. + +We kindly ask that you **do not** open a public GitHub issue to report security concerns. + +Instead, please submit the issue to the AWS Vulnerability Disclosure Program via [HackerOne](https://hackerone.com/aws_vdp) or send your report via [email](mailto:aws-security@amazon.com). + +For more details, visit the [AWS Vulnerability Reporting Page](http://aws.amazon.com/security/vulnerability-reporting/). + +Thank you in advance for collaborating with us to help protect our customers.