✨ 🚀 ✨ [Docs] Update README

FormalLanguageConstrainedPathQuerying · Nov 9, 2021 · 75e80b3 · 75e80b3
1 parent a3ca667
commit 75e80b3
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,5 +1,5 @@
 ---
-name: Bug report
+name: BUG REPORT
 about: Create a report to help us improve
 title: "[BUG] <Bug brief description>"
 labels: bug

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,5 +1,5 @@
 ---
-name: Feature request
+name: FEATURE REQUEST
 about: Suggest an idea for this project
 title: "[FEATURE] <Feature brief description>"
 labels: enhancement

diff --git a/.github/ISSUE_TEMPLATE/graph-add-template.md b/.github/ISSUE_TEMPLATE/graph-add-template.md
@@ -1,5 +1,5 @@
 ---
-name: Graph add template
+name: ADD NEW GRAPH
 about: Suggest new graph to this project
 title: "[NEW GRAPH] <Graph brief description>"
 labels: new graph

diff --git a/README.rst b/README.rst
@@ -48,8 +48,11 @@ Load graph from Dataset
 
    >>> bzip_path = cfpq_data.download("bzip")
    >>> bzip = cfpq_data.graph_from_csv(bzip_path)
-   
+
 How to add a new graph?
 ***********************
 
-Just create a PR (Pull Request) corresponding to the `"Template for adding a new graph" <https://github.com/JetBrains-Research/CFPQ_Data/blob/master/.github/PULL_REQUEST_TEMPLATE/new_graph.md>`_.
+Just create
+
+- an ``Issue`` corresponding to the `"Issue template for adding a new graph" <https://github.com/JetBrains-Research/CFPQ_Data/blob/master/.github/ISSUE_TEMPLATE/graph-add-template.md>`_.
+- a ``Pull Request`` corresponding to the `"Pull request template for adding a new graph" <https://github.com/JetBrains-Research/CFPQ_Data/blob/master/.github/PULL_REQUEST_TEMPLATE/new_graph.md>`_.