A big welcome and thank you for considering contributing to the project!
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved.
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- Search for existing Issues and PRs before creating your own.
- I make sure issues 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, see the first timer's guide on our blog by Auth0.
Issues should be used to report problems, request a new feature, or to discuss potential changes before a PR is created.
PRs are always welcome and can be a quick way to get your fix or improvement you desire. In general, PRs should:
- Only fix/add the functionality in question.
- Address a single concern in the least number of changed lines as possible.
- Be as much as descriptive on the changes you've made to the code.
In general, 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.