From faae076f102ebe98c50e2948bf4971b1b415dbe6 Mon Sep 17 00:00:00 2001 From: Tim Lawton <85966553+TimLawton-Auth0@users.noreply.github.com> Date: Fri, 1 Apr 2022 12:05:30 -0700 Subject: [PATCH 1/4] IUM-1930 updated/created markdown files --- CODEOWNERS | 2 ++ CONTRIBUTING.md | 1 + README.md | 1 + 3 files changed, 4 insertions(+) create mode 100644 CODEOWNERS create mode 100644 CONTRIBUTING.md diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..23a3d900 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# Code owners are automatically requested for review when someone opens a pull request that modifies code that they own. +* @auth0/iam-user-management-engineer \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e35653cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +# Usage and running test steps are located in README.md at the root of this repository \ No newline at end of file diff --git a/README.md b/README.md index 0c42c8bc..8775b99c 100644 --- a/README.md +++ b/README.md @@ -64,3 +64,4 @@ Bundle file (`auth0-account-link.extension.VERSION.js` is found in `/dist` Asset CSS files are found in `/dist/assets` Follow the instructions in the deployment tool. This tool will also automatically generate a PR in the `auth0-extensions` repo. Only after the PR is merged will the extension be available in production. Before merging the PR you can use this tool to test the upgrade: https://github.com/auth0-extensions/auth0-extension-update-tester by overriding the `extensions.json` file that is fetched by the dashboard. You will need to clone this repo: https://github.com/auth0/auth0-extensions, update `extensions.json` locally and then run `npx http-server --port 3000 --cors` to serve up the file. Then configure the extension with `http://localhost:3000/extensions.json` as the path. + From 36bc976715e02f14a30cba05013bbe5e55a05334 Mon Sep 17 00:00:00 2001 From: Tim Lawton <85966553+TimLawton-Auth0@users.noreply.github.com> Date: Fri, 1 Apr 2022 12:54:08 -0700 Subject: [PATCH 2/4] Update CODEOWNERS --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 23a3d900..790d5228 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,2 +1,2 @@ # Code owners are automatically requested for review when someone opens a pull request that modifies code that they own. -* @auth0/iam-user-management-engineer \ No newline at end of file +* @auth0-extensions/iam-user-management-engineer From 31917edd4d96967f923babb37695fac7284f5210 Mon Sep 17 00:00:00 2001 From: Tim Lawton <85966553+TimLawton-Auth0@users.noreply.github.com> Date: Thu, 7 Apr 2022 08:00:29 -0700 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 60 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e35653cc..249ddcb9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1 +1,60 @@ -# Usage and running test steps are located in README.md at the root of this repository \ No newline at end of file +# Contributing to Auth0 projects + +A big welcome and thank you for considering contributing to the Auth0 open source projects. It’s people like you that make it a reality for users in our community. + +Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests. + +### Quicklinks + +* [Code of Conduct](#code-of-conduct) +* [Getting Started](#getting-started) + * [Making Changes](#making-changes) + * [Opening Issues](#opening-issues) + * [Submitting Pull Requests](#submitting-pull-requests) +* [Getting in Touch](#getting-in-touch) + * [Got a question or problem?](#got-a-question-or-problem?) + * [Vulnerability Reporting](#vulnerability-reporting) + +## Code of Conduct + +By participating and contributing to this project, you are expected to uphold our [Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). + +## Getting Started + +### Making Changes + +When contributing to a repository, the first step is to open an issue in that repository to discuss the change you wish to make before making them. + +### Opening Issues + +Before you submit a new issue please make sure to search all open and closed issues. It is possible your feature request/issue has already been answered. + +[Opening an issue] (https://auth0.com/docs/troubleshoot/customer-support/open-and-manage-support-tickets). + +### Submitting Pull Requests + +Same goes for PRs, please search all open and closed PRs before submitting a new one. We do not want duplicate effort. + +In general, we follow the "fork-and-pull" Git workflow. + +* Fork the repository to your own Github account +* Clone the project to your machine +* Create a branch locally with a succinct but descriptive name +* Commit changes to the branch +* Push changes to your fork +* Open a Pull Request in the repository (not your own fork) and follow the PR template so that we can efficiently review the changes. +* This repository requires 2 reviewers from the IAM-User Management Engineering Team before a Pull Request can be merged. + +NOTE: Be sure to merge the latest from "upstream" before making a pull request. + +## Getting in touch + +### Have a question or problem? + +Please do not open issues for general support or usage questions. Instead, join us over in the Auth0 community at [community.auth0.com](https://community.auth0.com) and post your question there in the correct category with a descriptive tag. + +### Vulnerability Reporting + +Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. + +# Usage and running test steps are located in README.md at the root of this repository From b99f7f1ce31735f4e12d37af17f0a9e7f859ae3e Mon Sep 17 00:00:00 2001 From: Tim Lawton <85966553+TimLawton-Auth0@users.noreply.github.com> Date: Mon, 18 Apr 2022 08:22:33 -0700 Subject: [PATCH 4/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 33 ++++++--------------------------- 1 file changed, 6 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 249ddcb9..befca0a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,15 @@ + # Contributing to Auth0 projects -A big welcome and thank you for considering contributing to the Auth0 open source projects. It’s people like you that make it a reality for users in our community. +A big welcome and thank you for considering contributing to the Auth0 projects. It’s people like you that make it a reality for users in our community. -Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests. +Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue. ### Quicklinks * [Code of Conduct](#code-of-conduct) * [Getting Started](#getting-started) * [Making Changes](#making-changes) - * [Opening Issues](#opening-issues) - * [Submitting Pull Requests](#submitting-pull-requests) * [Getting in Touch](#getting-in-touch) * [Got a question or problem?](#got-a-question-or-problem?) * [Vulnerability Reporting](#vulnerability-reporting) @@ -23,29 +22,9 @@ By participating and contributing to this project, you are expected to uphold ou ### Making Changes -When contributing to a repository, the first step is to open an issue in that repository to discuss the change you wish to make before making them. - -### Opening Issues - -Before you submit a new issue please make sure to search all open and closed issues. It is possible your feature request/issue has already been answered. - -[Opening an issue] (https://auth0.com/docs/troubleshoot/customer-support/open-and-manage-support-tickets). - -### Submitting Pull Requests - -Same goes for PRs, please search all open and closed PRs before submitting a new one. We do not want duplicate effort. - -In general, we follow the "fork-and-pull" Git workflow. - -* Fork the repository to your own Github account -* Clone the project to your machine -* Create a branch locally with a succinct but descriptive name -* Commit changes to the branch -* Push changes to your fork -* Open a Pull Request in the repository (not your own fork) and follow the PR template so that we can efficiently review the changes. -* This repository requires 2 reviewers from the IAM-User Management Engineering Team before a Pull Request can be merged. +To contribute to a repository, the first step is to open a support ticket -NOTE: Be sure to merge the latest from "upstream" before making a pull request. +[Opening a ticket] (https://auth0.com/docs/troubleshoot/customer-support/open-and-manage-support-tickets). ## Getting in touch @@ -57,4 +36,4 @@ Please do not open issues for general support or usage questions. Instead, join Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. -# Usage and running test steps are located in README.md at the root of this repository +# More Information about this service is located in README.md at the root of this repository