Skip to content

Commit 5126f4e

Browse files
bekicotiaincollins
andauthored
CONTRIBUTING.md: Fix spelling and other issue (#810)
Co-authored-by: Iain Collins <me@iaincollins.com>
1 parent e09dfc6 commit 5126f4e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

CONTRIBUTING.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Contributions and feedback on your experience of using this software are welcome.
44

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.
66

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.
88

99
Please raise any significant new functionality or breaking change an issue for discussion before raising a Pull Request for it.
1010

@@ -13,14 +13,14 @@ Please raise any significant new functionality or breaking change an issue for d
1313
* The latest changes are always in `main`
1414
* Pull Requests should be raised for larger changes
1515
* 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)
1717
* 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
1919
* Pushing directly to main should ideally be reserved for minor updates (e.g. correcting typos) or small single-commit fixes
2020

2121
## Rebasing
2222

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!*
2424

2525
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:
2626

@@ -33,13 +33,13 @@ If there are any conflicts, you can resolve them and stage the files, then run:
3333

3434
*If there are a lot of changes you may be prompted to step more than once.*
3535

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:
3737

3838
git push --force-with-lease
3939

4040
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.
4141

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.*
4343

4444
You can use `npm run lint:fix` to automatically apply Standard JS rules to resolve formatting differences (tabs vs spaces, line endings, etc).
4545

@@ -71,7 +71,7 @@ A quick and dirty guide on how to setup *next-auth* locally to work on it and te
7171

7272
That's it!
7373

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`.
7575

7676
If you need an example project to link to, you can use [next-auth-example](https://github.com/iaincollins/next-auth-example).
7777

@@ -84,7 +84,7 @@ You might find it helpful to use the `npm run watch` command in the next-auth pr
8484

8585
If you are working on `next-auth/src/client/index.js` hot reloading will work as normal in your Next.js app.
8686

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:
8888

8989
```
9090
const clearRequireCachePlugin = require('webpack-clear-require-cache-plugin')
@@ -106,22 +106,22 @@ module.exports = {
106106

107107
### Databases
108108

109-
Included is a Docker Compose file that starts up MySQL, Postgres and MongoDB databases on localhost.
109+
Included is a Docker Compose file that starts up MySQL, Postgres, and MongoDB databases on localhost.
110110

111-
It will use port 3306, 5432 and 27017 on localhost respectively; it will not work if are running existing databases on localhost.
111+
It will use port 3306, 5432, and 27017 on localhost respectively; it will not work if are running existing databases on localhost.
112112

113113
You can start them with `npm run db:start` and stop them with `npm run db:stop`.
114114

115115
You will need Docker installed to be able to start / stop the databases.
116116

117-
When stop the databases, it will reset their contents.
117+
When stopping the databases, it will reset their contents.
118118

119119
### Testing
120120

121121
Tests can be run with `npm run test`.
122122

123123
Automated tests are currently crude and limited in functionality, but improvements are in development.
124124

125-
Currently to run tests you need to first have started local test databases (e.g. using `npm run db:start`).
125+
Currently, to run tests you need to first have started local test databases (e.g. using `npm run db:start`).
126126

127127
The databases can take a few seconds to start up, so you might need to give it a minute before running the tests.

0 commit comments

Comments
 (0)