diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 00000000..790d5228 --- /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-extensions/iam-user-management-engineer diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..befca0a0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ + +# Contributing to Auth0 projects + +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. + +### Quicklinks + +* [Code of Conduct](#code-of-conduct) +* [Getting Started](#getting-started) + * [Making Changes](#making-changes) +* [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 + +To contribute to a repository, the first step is to open a support ticket + +[Opening a ticket] (https://auth0.com/docs/troubleshoot/customer-support/open-and-manage-support-tickets). + +## 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. + +# More Information about this service is located in README.md at the root of this repository 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. +