doc: fix the issue template

manticore-projects · manticore-projects · commit b707b23ea336 · 2023-02-01T08:11:19.000+07:00
- fix the issue template
- fix the -SNAPSHOT version number
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,28 +1,41 @@
 ---
-name: SQL Parser Error
+name: @ SQL Parser Error
 about: Create a report to help us improve
-title: 'JSQLParser Version : RDBMS : failing feature description'
+title: '[BUG] JSQLParser Version : RDBMS : failing feature description'
 labels: 'Parser Error', 'Feature Request', 'Documentation', 'Java API', 'RDBMS support'
 assignees: ''
 
 ---
 
-**Failing SQL Feature**
+<!--
+Note: Please search to see if an issue already exists for the bug you encountered.
+-->
+
+### Failing SQL Feature:
+<!--
 - Brief description of the failing SQL feature
 - Example: `WITH ROLLUP` can't be parsed
+-->
 
-**SQL Example**
+### SQL Example:
+<!--
 - Simplified Query Example, focusing on the failing feature
 ```sql
 -- Replace with your ACTUAL example
 select 1
 from dual
 ```
+-->
 
-**Software Information**
+### Software Information:
+<!--
 - JSqlParser version
 - Database (e. g. Oracle, MS SQL Server, H2, PostgreSQL, IBM DB2 )
+-->
 
-**Tips**
+### Tips:
+<!--
 Please write in English and avoid Screenshots (as we can't copy and paste content from it).
 [Try your example online with the latest JSQLParser](http://217.160.215.75:8080/jsqlformatter/demo.html) and share the link in the error report.
+Do provide Links or References to the specific Grammar and Syntax you are trying to use.
+-->
diff --git a/build.gradle b/build.gradle
@@ -49,7 +49,7 @@ def getVersion = { boolean considerSnapshot ->
         patch = matcher[0][3]
         commit = matcher[0][4]
 
-        if (considerSnapshot && os.toString().trim().endsWith("-SNAPSHOT")) {
+        if (considerSnapshot) {
             minor++
             snapshot =  "-SNAPSHOT"
         }
@@ -314,6 +314,9 @@ task gitChangelogTask(type: GitChangelogTask) {
     file = new File("${projectDir}/src/site/sphinx/changelog.rst")
     fromRef = "4.0"
     //toRef = "1.1";
+
+    // switch off the formatter since the indentation matters for Mark-down
+    // @formatter:off
     templateContent ="""
 ************************
 Changelog
@@ -342,6 +345,7 @@ Version {{name}}
  {{/issues}}
 {{/tags}}
 """
+    // @formatter:on
 }
 
 task updateKeywords(type: JavaExec) {
