diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 92878fe..334eb95 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bb18c4b..f9df480 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 814ab34..581c942 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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. +. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the @@ -116,7 +116,7 @@ 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. +. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). @@ -124,5 +124,5 @@ 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. +. Translations are available at +. diff --git a/examples/README.md b/examples/README.md index 9c6d272..548c11c 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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 @@ -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 diff --git a/examples/USAGE.md b/examples/USAGE.md index bcfe66a..192958d 100644 --- a/examples/USAGE.md +++ b/examples/USAGE.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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