mirror of
https://github.com/instaloader/instaloader.git
synced 2024-09-11 16:22:24 +02:00
Improve contributing.rst and issue templates
This commit is contained in:
parent
b542936c09
commit
4e8236b6e9
7
.github/ISSUE_TEMPLATE/bug_report.md
vendored
7
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: 🐛 Bug report
|
||||||
about: Create a report to help us improve
|
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**
|
**Additional context**
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
|
||||||
|
(please also see https://instaloader.github.io/contributing.html for how to report a bug)
|
||||||
|
11
.github/ISSUE_TEMPLATE/feature_request.md
vendored
11
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
name: Feature request
|
name: 🚀 Feature Suggestion
|
||||||
about: Suggest an idea for this project
|
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**
|
**Describe alternatives you've considered**
|
||||||
A clear and concise description of any alternative solutions or features 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**
|
**Additional context**
|
||||||
Add any other context about the feature request here.
|
Add any other context about the feature request here.
|
||||||
|
|
||||||
|
(please also see https://instaloader.github.io/contributing.html for how to suggest a feature)
|
||||||
|
8
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
8
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@ -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...
|
@ -15,10 +15,8 @@ Reporting Bugs
|
|||||||
--------------
|
--------------
|
||||||
|
|
||||||
If you encounter a bug, do not hesitate to report it in our
|
If you encounter a bug, do not hesitate to report it in our
|
||||||
`Issue Tracker <https://github.com/instaloader/instaloader/issues>`__. Since
|
`Issue Tracker <https://github.com/instaloader/instaloader/issues>`__. When
|
||||||
Instaloader is actively developed, the majority of bugs is fixed within only
|
reporting a problem, please keep the following in mind:
|
||||||
**4 days** after being reported. When reporting a problem, please keep the
|
|
||||||
following in mind:
|
|
||||||
|
|
||||||
- Ensure you **use the latest version** of Instaloader. The currently-installed
|
- Ensure you **use the latest version** of Instaloader. The currently-installed
|
||||||
version can be found out with ``instaloader --version``.
|
version can be found out with ``instaloader --version``.
|
||||||
@ -66,6 +64,16 @@ few things to consider:
|
|||||||
Suggesting Features
|
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
|
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
|
implement the feature yourself, feel free to open a ticket in our
|
||||||
`Issue Tracker <https://github.com/instaloader/instaloader/issues>`__.
|
`Issue Tracker <https://github.com/instaloader/instaloader/issues>`__.
|
||||||
@ -82,6 +90,9 @@ Please consider the following:
|
|||||||
invoke the new function? Which problem would it solve? If new information is
|
invoke the new function? Which problem would it solve? If new information is
|
||||||
obtained, how would it be further processed?
|
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
|
- **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
|
feature suggestions. Keep in mind that this is a free software project, and
|
||||||
unfortunately we only have limited time to work on it.
|
unfortunately we only have limited time to work on it.
|
||||||
|
Loading…
Reference in New Issue
Block a user