From 7812205c9928989f488614e9ebc857db558bf5f8 Mon Sep 17 00:00:00 2001
From: Piotr Semenov
Date: Fri, 17 May 2024 19:35:48 +0400
Subject: [PATCH] chore: add templates for bug/feature issues
---
.github/ISSUE_TEMPLATE/1-bug.yml | 27 ++++++++++
.github/ISSUE_TEMPLATE/2-feature.yml | 24 +++++++++
.pre-commit-config.yaml | 2 +-
README.md | 75 ++++++++++++++++++++++------
4 files changed, 112 insertions(+), 16 deletions(-)
create mode 100644 .github/ISSUE_TEMPLATE/1-bug.yml
create mode 100644 .github/ISSUE_TEMPLATE/2-feature.yml
diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml
new file mode 100644
index 0000000..4e1d409
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug.yml
@@ -0,0 +1,27 @@
+# yamllint disable rule:line-length
+---
+name: ๐ Bug Report
+description: File a bug/issue
+title: '[Bug]: '
+assignees: ['piotr-semenov']
+labels: ['bug']
+body:
+ - type: textarea
+ attributes:
+ label: PARI/GP syntax failure
+ description: Example of wrong syntax markup of your PARI/GP code.
+ placeholder: |+
+ Wrong markup for code below.
+ ```text
+ Your PARI/GP code here
+ ```
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Any other problem (installation issues, build failures, etc.)
+ description: |
+ Anything about the issue you are encountering: description, screenshots, etc.
+ placeholder: Your description here...
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml
new file mode 100644
index 0000000..77a16d1
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature.yml
@@ -0,0 +1,24 @@
+# yamllint disable rule:line-length
+---
+name: ๐ก Feature Request
+description: Suggest an idea to enhance this project
+title: '[Feature]: '
+assignees: ['piotr-semenov']
+labels: ['enhancement']
+body:
+ - type: textarea
+ id: feature-proposal
+ attributes:
+ label: What would you like to add to this project?
+ description: Description of the feature or enhancement wanted.
+ placeholder: Your feature proposal here...
+ validations:
+ required: true
+ - type: textarea
+ id: feature-reason
+ attributes:
+ label: Why is this needed?
+ description: Please, provide the use case example why you need this feature.
+ placeholder: Your use case example here...
+ validations:
+ required: true
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 1362361..1125137 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -37,7 +37,7 @@ repos:
name: lints yaml
entry: yamllint
language: system
- files: '.*\.(yaml|YAML-tmLanguage)'
+ files: '.*\.(yaml|yml|YAML-tmLanguage)'
# xml
- repo: local
hooks:
diff --git a/README.md b/README.md
index f195bea..8ea783b 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,67 @@
-
-# PARI/GP Programming Language
-
+
- A Textmate language grammar for programming language of PARI/GP computer algebra system.
-
- Report bug
- ยท
- Request feature
-
-
-
+
PARI/GP Programming Language
+
+ A Textmate language grammar for programming language of PARI/GP computer algebra system.
+
+ Report bug
+ ยท
+ Request feature
+
+
+
+
+
## Table of Contents
-- [Install into Visual Studio Code](#install-into-visual-studio-code)
-- [Install into Sublime Text 3](#install-into-sublime-text-3)
+- [Use in Visual Studio Code](#use-in-visual-studio-code)
+ - [How to install](#vsix-how-to-install)
+ - [What's included in package](#vsix-whats-included-in-package)
+- [Use in Sublime Text](#use-in-sublime-text)
+ - [How to install](#st-how-to-install)
+ - [What's included in package](#st-whats-included-in-package)
+- [How to build on your own](#how-to-build-on-your-own)
+- [Creators](#creators)
+
+## Use in Visual Studio Code
+
+### How to install
+
+Some text.
+
+### What's included in package
+
+```text
+folder1/
+โโโ folder2/
+ โโโ folder3/
+ โ โโโ file1
+ โ โโโ file2
+ โโโ folder4/
+ โโโ file3
+ โโโ file4
+```
+
+## Use in Sublime Text
+
+Some text.
+
+### How to install
+
+Some text.
+
+### What's included in package
+
+Some text.
+
+## How to build on your own
+
+```bash
+VER=23.11 vagrant up
+```
-## Install into Visual Studio Code
+## Creators
-## Install into Sublime Text 3
+-