mirror of
https://github.com/SrIzan10/next-auth.git
synced 2026-05-01 10:55:20 +00:00
27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
# Contributing guide
|
|
|
|
Contributions and feedback on your experience of using this software are welcome.
|
|
|
|
This includes bug reports, feature requests, ideas, pull requests, and examples of how you have used this software.
|
|
|
|
Please see the [Code of Conduct](CODE_OF_CONDUCT.md) and follow any templates configured in GitHub when reporting bugs, requesting enhancements, or contributing code.
|
|
|
|
Please raise any significant new functionality or breaking change an issue for discussion before raising a Pull Request for it.
|
|
|
|
## For contributors
|
|
|
|
Anyone can be a contributor. Either you found a typo, or you have an awesome feature request you could implement, we encourage you to create a Pull Request.
|
|
|
|
### Pull Requests
|
|
|
|
- The latest changes are always in `main`, so please make your Pull Request against that branch.
|
|
- Pull Requests should be raised for any change
|
|
|
|
### Setting up local environment
|
|
|
|
The local environment can be setup by doing the following.
|
|
|
|
1. Clone the repository `$ git clone https://github.com/nextauthjs/docs.git`
|
|
2. Install dependencies `$ npm install`
|
|
3. Start development server `$ npm start`
|