Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TimLawton-Auth0 authored Apr 7, 2022
1 parent 35e6541 commit 5f29e1b
Showing 1 changed file with 60 additions and 1 deletion.
61 changes: 60 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,60 @@
# Usage and running test steps are located in README.md at the root of this repository
# 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

0 comments on commit 5f29e1b

Please sign in to comment.