From dbe41e3b08858708db23e553f8fe6ec228b3d2f0 Mon Sep 17 00:00:00 2001 From: Brian Muller Date: Sat, 24 Nov 2018 10:01:27 -0500 Subject: [PATCH] updated issue template, readme --- .github/ISSUE_TEMPLATE/bug_report.md | 11 +++-------- README.md | 3 +++ 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b735373..559f399 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: Create an issue report to help us improve --- @@ -21,15 +21,10 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - - OS: [e.g. iOS] + - OS: [e.g. OSX] - Browser [e.g. chrome, safari] - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + - Python Version [e.g. 3.6.6] **Additional context** Add any other context about the problem here. diff --git a/README.md b/README.md index 1bc8e2c..581009d 100644 --- a/README.md +++ b/README.md @@ -65,5 +65,8 @@ pip install -r dev-requirements.txt python -m unittest ``` +## Reporting Issues +Please report all issues [on github](https://github.com/bmuller/kademlia/issues). + ## Fidelity to Original Paper The current implementation should be an accurate implementation of all aspects of the paper save one - in Section 2.3 there is the requirement that the original publisher of a key/value republish it every 24 hours. This library does not do this (though you can easily do this manually).