Skip to content

Commit

Permalink
chore: add templates for bug/feature issues
Browse files Browse the repository at this point in the history
  • Loading branch information
piotr-semenov committed May 17, 2024
1 parent 672eaff commit 7812205
Show file tree
Hide file tree
Showing 4 changed files with 112 additions and 16 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -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
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
75 changes: 60 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,67 @@
<!-- markdownlint-disable MD033 -->
# PARI/GP Programming Language

<!-- markdownlint-disable MD041 MD033 -->
<p align="center">
A Textmate language grammar for programming language of PARI/GP computer algebra system.
<br />
<a href="https://github.com/piotr-semenov/parigp-lang/issues/new?labels=bug&assignees=piotr-semenov">Report bug</a>
·
<a href="https://github.com/piotr-semenov/parigp-lang/issues/new?labels=enhancement">Request feature</a>
<br />
<img alt="Grammar Coverage" src="https://raw.githubusercontent.com/piotr-semenov/parigp-lang/main/images/coverage-badge.svg" height="20" />
<a href="http://pari.math.u-bordeaux.fr/"><img alt="PARI/GP Logo" src="http://pari.math.u-bordeaux.fr/site_icons/PARI-GP-small.png" height="20" border="1" /></a>
<h2 align="center">PARI/GP Programming Language</h2>
<p align="center">
A Textmate language grammar for programming language of PARI/GP computer algebra system.
<br />
<a href="https://github.com/piotr-semenov/parigp-lang/issues/new?template=1-bug.yml">Report bug</a>
·
<a href="https://github.com/piotr-semenov/parigp-lang/issues/new?template=2-feature.yml">Request feature</a>
<br />
<img alt="Grammar Coverage" src="https://raw.githubusercontent.com/piotr-semenov/parigp-lang/main/images/coverage-badge.svg" height="20" />
<a href="http://pari.math.u-bordeaux.fr/"><img alt="PARI/GP Logo" src="http://pari.math.u-bordeaux.fr/site_icons/PARI-GP-small.png" height="20" border="1" /></a>
<a href="https://matrix.to/#/#parigp-lang:gitter.im"><img alt="Join the chat" src="https://badges.gitter.im/Join%20Chat.svg" height="20" /></a>
</p>
</p>

## 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

### <a id="vsix-how-to-install"></a> How to install

Some text.

### <a id="vsix-whats-included-in-package"></a> What's included in package

```text
folder1/
└── folder2/
├── folder3/
│ ├── file1
│ └── file2
└── folder4/
├── file3
└── file4
```

## Use in Sublime Text

Some text.

### <a id="st-how-to-install"></a> How to install

Some text.

### <a id="st-whats-included-in-package"></a> 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
- <https://github.com/piotr-semenov/>

0 comments on commit 7812205

Please sign in to comment.