Skip to content

Commit

Permalink
✨ 🚀 ✨ [Project] Add issue's templates
Browse files Browse the repository at this point in the history
  • Loading branch information
vadyushkins authored Nov 9, 2021
1 parent de38e4a commit a3ca667
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] <Bug brief description>"
labels: bug
assignees: vdshk

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: `[e.g. Ubuntu 20.04]`
- CFPQ_Data: `[e.g. 22]`
- Python: `[e.g. 3.8]`
- Other important stuff versions

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE] <Feature brief description>"
labels: enhancement
assignees: vdshk

---

**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.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/graph-add-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Graph add template
about: Suggest new graph to this project
title: "[NEW GRAPH] <Graph brief description>"
labels: new graph
assignees: vdshk

---

<!-- ⚠ To suggest a new graph, you must fill in all the fields in the triangle brackets(``<>``) ⚠ -->

## Info
| | |
|---|---|
| Full Name | ``<Specify the full name of the graph>`` |
| Version | ``<Current version of CFPQ_Data>`` |
| Origin | [link](``<Link to download the graph>``) |

## CSV File Structure

| Column Number | Column Type | Column Description |
|:---:|:---:|---|
| 1 | int | The tail of the edge |
| 2 | int | The head of the edge |
| 3 | str | The label of the edge |

## Graph Statistics
| Num Nodes | Num Edges |
|:---:|:---:|
| ``<The number of nodes in the new graph>`` | ``<The number of edges in the new graph>`` |

## Edges Statistics
| Edge Label | Num Edge Label |
|---:|---:|
| ``<The type of the edge label of the new graph >`` | ``<The number of edges in the new graph of this type>`` |

## Canonical grammars

<LaTeX format of grammar>

<Pyformlang CFG format of grammar>

0 comments on commit a3ca667

Please sign in to comment.