diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 15c26b4..7c593b2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,20 +7,20 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +### Describe the bug** +[//]: # A clear and concise description of what the bug is. -**Expected behavior** -A clear and concise description of what you expected to happen. +### Expected behavior** +[//]: # A clear and concise description of what you expected to happen. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +### To Reproduce +[//]: # Steps to reproduce the behavior: +[//]: # 1. Go to '...' +[//]: # 2. Click on '....' +[//]: # 3. Scroll down to '....' +[//]: # 4. See error -**Context** +### Context [//]: # Fetch from "pg-schema-diff version" if using the CLI or go.mod if using the library pg-schema-diff version: Some sha or version [//]: # If you are using the CLI or using the library programatically @@ -28,3 +28,4 @@ pg-schema-diff usage: [CLI | LIBRARY] Postgres version: [14, 15, 16, 17] [//]: # Only if relevant pg_dump of database: Gist link + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c9387cb..c8197b9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,8 +7,8 @@ assignees: '' --- -**Describe the feature** -Provide a thorough description of the feature. If possible, include examples of the feature and its behavior. For example, if it's a new command flag, provide examples of using the command flag and expected outputs. +### Describe the feature +[//]: # Provide a thorough description of the feature. If possible, include examples of the feature and its behavior. For example, if it's a new command flag, provide examples of using the command flag and expected outputs. -**Motivation* -Describe why you want this feature. This is important for assessing the priority of the feature and if alternative solutions exist. +### Motivation +[//]: # Describe why you want this feature. This is important for assessing the priority of the feature and if alternative solutions exist. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7af9911..ee93f4d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,10 +1,10 @@ -[//]: # (README: Ensure you've read the CONTRIBUTING.MD and that your commits are signed) +[//]: # README: Ensure you've read the CONTRIBUTING.MD and that your commits are signed ### Description -[//]: # (A clear and concise description of the purpose of this Pull Request. What is being changed? Include any relevant background for this change.) +[//]: # A clear and concise description of the purpose of this Pull Request. What is being changed? Include any relevant background for this change. ### Motivation -[//]: # (Why you made these changes. Link to any relevant issues.) +[//]: # Why you made these changes. Link to any relevant issues. ### Testing -[//]: # (Describe how you tested these changes) +[//]: # Describe how you tested these changes