Skip to content

Docs: Fix spellings in CONTRIBUTING.md and Examples README.md #1569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: Fix spellings in CONTRIBUTING.md and Examples README.md #1569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ As such, you must adhere to the following guidelines.

### Bug Reports

Bug reports are essential to the success of this libary, please follow these guidelines:
Bug reports are essential to the success of this library, please follow these guidelines:
* A single bug report per issue
* Multiple bugs per issue makes it difficult to prioritize and track progress.
* Contributors will most likely end up splitting your bug report up into multiple fixes, if you can save them some time by splitting your report up beforehand it is greatly appreciated.
Expand Down Expand Up @@ -89,7 +89,7 @@ Your unit tests should cover as many code paths as possible including error case

### E2E Tests

`e2e` test cases should cover high level functionaly not focusing on all code paths but ensuring that your code is covered when called all the way through the stack as you expect.
`e2e` test cases should cover high level functionality not focusing on all code paths but ensuring that your code is covered when called all the way through the stack as you expect.

Most test cases can be included in an example that already exists. If you are including an entirely new feature that you cannot integration tested without changing existing functionality feel free to create a new example.

Expand All @@ -101,7 +101,7 @@ To add a new example follow these steps
* `examples/init-scripts/mysql` - See the [basic example](https://github.com/doug-martin/nestjs-query/blob/master/examples/init-scripts/mysql/init-basic.sql)
* `examples/init-scripts/postgres` - See the [basic example](https://github.com/doug-martin/nestjs-query/blob/master/examples/init-scripts/postgres/init-basic.sql)
* All files should match the following format `init-{example-name}.sql`
* Your init script should create a `USER`, `DATABASE` and `GRANT PRIVELAGES` to the user for the database.
* Your init script should create a `USER`, `DATABASE` and `GRANT PRIVILEGES` to the user for the database.
* Be sure to use the user you created in your `app.module.ts` file. See [the basic example](https://github.com/doug-martin/nestjs-query/blob/master/examples/basic/src/app.module.ts)
* Add your modules and tests.

Expand Down Expand Up @@ -158,7 +158,7 @@ npm run jest

Format: `<type>(<scope>): <subject>`

`<scope>` is optional, but is typically the scope of the feature either package (e.g. `core`, `grapqql`, `typeorm` etc)
`<scope>` is optional, but is typically the scope of the feature either package (e.g. `core`, `graphql`, `typeorm` etc)

Example
```
Expand Down Expand Up @@ -205,8 +205,8 @@ If you find yourself in a situation where you are adding a new feature or docume
* `introduction` - A quick introduction for developers with installation guides, a feature list and example application.
* `concepts` - Core concepts required to get started in `nestjs-query`
* `graphql` - All documentation that is graphql specific.
* `persistence` - Documentation related to the different persistence libary adapters.
* `utilities` - Miscellaneous utilties that are useful when building an application.
* `persistence` - Documentation related to the different persistence library adapters.
* `utilities` - Miscellaneous utilities that are useful when building an application.
* `migration-guides` - Documentation on how to upgrade between versions when breaking changes are introduced.
* `faq.md` - Common questions with links to the relevant documentation.

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To run an example execute `npm run start -- {example_name}` where example name i
* [`sequelize`](./sequelize) - Example GraphQL API using sequelize
* [`subscriptions`](./subscriptions) - Example todo-item GraphQL API with subscriptions.
* [`typeorm`](./typeorm) - Example todo-item GraphQL API using typeorm
* [`typeorm-multidb`](./typeorm-multidb) - Example GraphQL API using typeorm with mutliple databases
* [`typeorm-multidb`](./typeorm-multidb) - Example GraphQL API using typeorm with multiple databases
* [`typeorm-soft-delete`](./typeorm-soft-delete) - - Example todo-item GraphQL API using typeorm with soft deletes.
* [`custom-service`](./custom-service) - - Example todo with a custom-implemented service class.

Expand Down