You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+13-13
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
Contributions and feedback on your experience of using this software are welcome.
4
4
5
-
This includes bug reports, feature requests, ideas, pull requests and examples of how you have used this software.
5
+
This includes bug reports, feature requests, ideas, pull requests, and examples of how you have used this software.
6
6
7
-
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.
7
+
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.
8
8
9
9
Please raise any significant new functionality or breaking change an issue for discussion before raising a Pull Request for it.
10
10
@@ -13,14 +13,14 @@ Please raise any significant new functionality or breaking change an issue for d
13
13
* The latest changes are always in `main`
14
14
* Pull Requests should be raised for larger changes
15
15
* Pull Requests do not need approval before merging for those with contributor access (it's just helpful to have them to track changes)
16
-
* Rebasing in Pull Requests is prefered to keep a clean commit history (see below)
16
+
* Rebasing in Pull Requests is preferred to keep a clean commit history (see below)
17
17
* Running `npm run lint:fix` before committing can make resolving conflicts easier, but is not required
18
-
* Merge commits (and pushing merge commits to `main`) are disabled in this repo; but commits in PR can be squashed so this is not a blocker
18
+
* Merge commits (and pushing merge commits to `main`) are disabled in this repo, but commits in PR can be squashed so this is not a blocker
19
19
* Pushing directly to main should ideally be reserved for minor updates (e.g. correcting typos) or small single-commit fixes
20
20
21
21
## Rebasing
22
22
23
-
*If you don't rebase and end up with merge commits in a PR then it's not a blocker, we can alway squash the commits when merging!*
23
+
*If you don't rebase and end up with merge commits in a PR then it's not a blocker, we can always squash the commits when merging!*
24
24
25
25
If you create a branch and there are conflicting updates in the `main` branch, you can resolve them by rebasing from a check out of your branch:
26
26
@@ -33,13 +33,13 @@ If there are any conflicts, you can resolve them and stage the files, then run:
33
33
34
34
*If there are a lot of changes you may be prompted to step more than once.*
35
35
36
-
When the rebase is complete (i.e. there are no more conflicts) you should push your changes to your branch before doing anyhing else:
36
+
When the rebase is complete (i.e. there are no more conflicts) you should push your changes to your branch before doing anything else:
37
37
38
38
git push --force-with-lease
39
39
40
40
You should see that any conflicts in your PR are now resolved. You can review changes to make sure it contains changes you intended to make.
41
41
42
-
*If you accidentally sync before pushing, it will trigger a merge. Uou can use `git merge --abort` to undo the merge.*
42
+
*If you accidentally sync before pushing, it will trigger a merge. You can use `git merge --abort` to undo the merge.*
43
43
44
44
You can use `npm run lint:fix` to automatically apply Standard JS rules to resolve formatting differences (tabs vs spaces, line endings, etc).
45
45
@@ -71,7 +71,7 @@ A quick and dirty guide on how to setup *next-auth* locally to work on it and te
71
71
72
72
That's it!
73
73
74
-
Notes: You may need to repeat both `npm link` steps if you install / update additional dependancies with `npm i`.
74
+
Notes: You may need to repeat both `npm link` steps if you install / update additional dependencies with `npm i`.
75
75
76
76
If you need an example project to link to, you can use [next-auth-example](https://github.com/iaincollins/next-auth-example).
77
77
@@ -84,7 +84,7 @@ You might find it helpful to use the `npm run watch` command in the next-auth pr
84
84
85
85
If you are working on `next-auth/src/client/index.js` hot reloading will work as normal in your Next.js app.
86
86
87
-
However if you are working on anything else (e.g. `next-auth/src/server/*` etc) then you will need to *stop and start* your app for changes to apply as **Next.js will not hot reload those changes by default**. To facitate this, you can try [this webpack plugin](https://www.npmjs.com/package/webpack-clear-require-cache-plugin). Note that the `next.config.js` syntax in the plugin README may be out of date. It should look like this:
87
+
However, if you are working on anything else (e.g. `next-auth/src/server/*` etc) then you will need to *stop and start* your app for changes to apply as **Next.js will not hot reload those changes by default**. To facilitate this, you can try [this webpack plugin](https://www.npmjs.com/package/webpack-clear-require-cache-plugin). Note that the `next.config.js` syntax in the plugin README may be out of date. It should look like this:
0 commit comments