A big welcome and thank you for considering contributing to this project! It’s people like you that make it a reality for our community.
We know that sometimes, the excitement to contribute is uncontrolled, but please, before any contribution, first discuss the change you wish to make via issue or discussion, with the owners of this repository before making a change. It will reduce your pains to review unnecessary PRs or work hard in PRs that never will be merged.
Also, note that we have a code of conduct. Follow it in all your interactions with the project.
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
Contributions are made to this repo via Issues, Discussions, and Pull Requests (PRs). A few general guidelines that cover both:
- To report security vulnerabilities, please use the Report a security vulnerability path which is monitored by the security team.
- Search for existing Issues, Discussions and PRs before creating your own.
- We work hard to makes sure issues, discussions, and PRs are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
- If you've never contributed before, read the first timer's guide on Auth0's blog for resources and tips on how to get started.
Issues should be used to report problems, request a new feature, or to discuss potential changes before a PR or a Discussion is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need.
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
PRs are always welcome.
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
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
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
This CONTRIBUTING.md is adapted from Auth0 CONTRIBUTING.md file.