From 75e80b31eeb79dc64b6f9d53a7b373762f7c9bb9 Mon Sep 17 00:00:00 2001 From: Vadim Abzalov Date: Tue, 9 Nov 2021 16:01:25 +0300 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20=F0=9F=9A=80=20=E2=9C=A8=20[Docs]?= =?UTF-8?q?=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/graph-add-template.md | 2 +- README.rst | 7 +++++-- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index bd8a7199..af3353bf 100644 --- 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] " labels: bug diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 1fd9eb8d..c9baf05c 100644 --- 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] " labels: enhancement diff --git a/.github/ISSUE_TEMPLATE/graph-add-template.md b/.github/ISSUE_TEMPLATE/graph-add-template.md index 520eb485..e2cd714b 100644 --- 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] " labels: new graph diff --git a/README.rst b/README.rst index 5f22dd08..28410c03 100644 --- 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" `_. +Just create + +- an ``Issue`` corresponding to the `"Issue template for adding a new graph" `_. +- a ``Pull Request`` corresponding to the `"Pull request template for adding a new graph" `_.