Skip to content

Commit

Permalink
docs(all): apply markdown lint [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
bartventer committed May 9, 2024
1 parent 703a095 commit f0f7fce
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 35 deletions.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,25 @@ assignees: ''
You have the option to utilize `go bug` for an automatically populated bug report template, or you can manually complete the template provided below.

### Describe the bug

A clear and concise description of what the bug is.

### To Reproduce

Steps to reproduce the behavior:

## Expected behavior

A clear and concise description of what you expected to happen.

### Screenshots

If applicable, add screenshots to help explain your problem.

### Version

Which version(s) of the `gorm-multitenancy` modules are you seeing the bug with?

### Additional context

Add any other context about the problem here.
6 changes: 5 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@ assignees: ''
> [!IMPORTANT]
> Please use a title starting with the name of the affected package, or "all", followed by a colon, followed by a short summary of the feature. Example: `middleware/echo: add context setting feature`.
### Is your feature request related to a problem? Please describe.
### Is your feature request related to a problem? Please describe

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

### Describe the solution you'd like

A clear and concise description of what you want to happen.

### Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

### Additional context

Add any other context or screenshots about the feature request here.
8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
bartventer@outlook.com.
<bartventer@outlook.com>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down Expand Up @@ -116,13 +116,13 @@ the community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
8 changes: 4 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

This directory contains examples of how to use the `gorm-multitenancy` package with different frameworks:

- [Echo](echo/README.md)
- [net/http](nethttp/README.md)
- [Echo](echo/README.md)
- [net/http](nethttp/README.md)

## Getting Started

Expand All @@ -14,13 +14,13 @@ git clone https://github.com/bartventer/gorm-multitenancy.git
cd gorm-multitenancy
```

- _Echo_:
- _Echo_:

```bash
cd ./examples/echo
```

- _net/http_:
- _net/http_:

```bash
cd ./examples/nethttp
Expand Down
52 changes: 26 additions & 26 deletions examples/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

#### Create tenant

- Parse the request body into a CreateTenantBody struct
- Create the tenant in the database (public schema)
- Create the schema for the tenant
- Return the HTTP status code 201 and the tenant in the response body
- Parse the request body into a CreateTenantBody struct
- Create the tenant in the database (public schema)
- Create the schema for the tenant
- Return the HTTP status code 201 and the tenant in the response body

##### Request

Expand All @@ -29,8 +29,8 @@ curl -X POST \

#### Get tenant

- Get the tenant from the database
- Return the HTTP status code 200 and the tenant in the response body
- Get the tenant from the database
- Return the HTTP status code 200 and the tenant in the response body

##### Request

Expand All @@ -50,10 +50,10 @@ curl -X GET \

#### Delete tenant

- Get the tenant from the database
- Delete the schema for the tenant
- Delete the tenant from the database
- Return the HTTP status code 204
- Get the tenant from the database
- Delete the schema for the tenant
- Delete the tenant from the database
- Return the HTTP status code 204

##### Request

Expand All @@ -70,9 +70,9 @@ curl -X DELETE \

#### Get books

- Get the tenant from the request host or header
- Get all books for the tenant
- Return the HTTP status code 200 and the books in the response body
- Get the tenant from the request host or header
- Get all books for the tenant
- Return the HTTP status code 200 and the books in the response body

##### Request

Expand All @@ -99,10 +99,10 @@ curl -X GET \

#### Create book

- Get the tenant from the request host or header
- Parse the request body into a Book struct
- Create the book for the tenant in the database
- Return the HTTP status code 201 and the book in the response body
- Get the tenant from the request host or header
- Parse the request body into a Book struct
- Create the book for the tenant in the database
- Return the HTTP status code 201 and the book in the response body

##### Request

Expand All @@ -127,10 +127,10 @@ curl -X POST \

#### Delete book

- Get the tenant from the request host or header
- Get the book from the database
- Delete the book from the database
- Return the HTTP status code 204
- Get the tenant from the request host or header
- Get the book from the database
- Delete the book from the database
- Return the HTTP status code 204

##### Request

Expand All @@ -148,11 +148,11 @@ curl -X DELETE \

#### Update book

- Get the tenant from the request host or header
- Get the book from the database
- Parse the request body into a UpdateBookBody struct
- Update the book in the database
- Return the HTTP status code 200
- Get the tenant from the request host or header
- Get the book from the database
- Parse the request body into a UpdateBookBody struct
- Update the book in the database
- Return the HTTP status code 200

##### Request

Expand Down

0 comments on commit f0f7fce

Please sign in to comment.