From 4e8236b6e92e999318f363a2a86d075ae9aa41dc Mon Sep 17 00:00:00 2001 From: Alexander Graf Date: Tue, 20 Aug 2019 22:05:49 +0200 Subject: [PATCH] Improve contributing.rst and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 7 +++++-- .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++++++-- .github/ISSUE_TEMPLATE/question.md | 8 ++++++++ docs/contributing.rst | 19 +++++++++++++++---- 4 files changed, 37 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 18496a8..fc885f3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,7 @@ --- -name: Bug report -about: Create a report to help us improve +name: 🐛 Bug report +about: Create a report to help us improve 🤕 +labels: bug --- @@ -22,3 +23,5 @@ If applicable, add error messages and tracebacks to help explain your problem. **Additional context** Add any other context about the problem here. + +(please also see https://instaloader.github.io/contributing.html for how to report a bug) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e952152..f96e4f6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,6 +1,7 @@ --- -name: Feature request -about: Suggest an idea for this project +name: 🚀 Feature Suggestion +about: Suggest an idea for this project 💡 +labels: "feature suggestion" --- @@ -13,5 +14,11 @@ 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. +**If the feature request is accepted, would you be willing to submit a PR?** + +Yes / No _(Help can be provided if you need assistance submitting a PR)_ + **Additional context** Add any other context about the feature request here. + +(please also see https://instaloader.github.io/contributing.html for how to suggest a feature) diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..39e32ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,8 @@ +--- +name: ❓ Question +about: If you have a question about how to use Instaloader that's not well covered by our documentation +labels: question + +--- + +Your question here... diff --git a/docs/contributing.rst b/docs/contributing.rst index 063ac00..0f969ed 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -15,10 +15,8 @@ Reporting Bugs -------------- If you encounter a bug, do not hesitate to report it in our -`Issue Tracker `__. Since -Instaloader is actively developed, the majority of bugs is fixed within only -**4 days** after being reported. When reporting a problem, please keep the -following in mind: +`Issue Tracker `__. When +reporting a problem, please keep the following in mind: - Ensure you **use the latest version** of Instaloader. The currently-installed version can be found out with ``instaloader --version``. @@ -66,6 +64,16 @@ few things to consider: Suggesting Features ------------------- +.. goal-start + +Instaloader's goal is to mimick the browser's behavior to access the data that +is available through the Instagram web interface, pack this data into complete +and easily-(re)usable python objects, and provide a user interface for the most +common downloading and metadata collection tasks, without changing any of the +online data. + +.. goal-end + If you have an idea of how Instaloader should be enhanced, but do not want to implement the feature yourself, feel free to open a ticket in our `Issue Tracker `__. @@ -82,6 +90,9 @@ Please consider the following: invoke the new function? Which problem would it solve? If new information is obtained, how would it be further processed? +- If not obvious, briefly motivate how your suggested feature **conforms with + Instaloader's project goal**. + - **Be patient**. Naturally, bugs and pull requests have a higher priority than feature suggestions. Keep in mind that this is a free software project, and unfortunately we only have limited time to work on it.