From af3d385ff52775e1ed65c683ee728959dece3fea Mon Sep 17 00:00:00 2001 From: Mads Marquart Date: Thu, 21 Jun 2018 16:41:27 +0200 Subject: [PATCH] Add issue templates via. Github's `Create Issue Template` feature --- .github/ISSUE_TEMPLATE/bug-report.md | 34 ++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++++ .../question---anything-else.md | 8 +++++ .github/ISSUE_TEMPLATE/question.md | 8 +++++ 5 files changed, 104 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question---anything-else.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..9903544a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report if you're having trouble with `fbchat` + +--- + +## Description of the problem +Example: Logging in fails when the character `%` is in the password. A specific password that fails is `a_password_with_%` + +## Code to reproduce +```py +# Example code +from fbchat import Client +client = Client("[REDACTED_USERNAME]", "a_password_with_%") +``` + +## Traceback +``` +Traceback (most recent call last): + File "", line 1, in + File "[site-packages]/fbchat/client.py", line 78, in __init__ + self.login(email, password, max_tries) + File "[site-packages]/fbchat/client.py", line 407, in login + raise FBchatUserError('Login failed. Check email/password. (Failed on url: {})'.format(login_url)) +fbchat.models.FBchatUserError: Login failed. Check email/password. (Failed on url: https://m.facebook.com/login.php?login_attempt=1) +``` + +## Environment information +- Python version +- `fbchat` version +- If relevant, output from `$ python -m pip list` + +If you have done any research, include that. +Make sure to redact all personal information. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..b7353733 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - 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] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..ac0c9189 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature request +about: Suggest a feature that you'd like to see implemented + +--- + +## Description +Example: There's no way to send messages to groups + +## Research (if applicable) +Example: I've found the URL `https://facebook.com/send_message.php`, to which you can send a POST requests with the following JSON: +```json +{ + "text": message_content, + "fbid": group_id, + "some_variable": ? +} +``` +But I don't know how what `some_variable` does, and it doesn't work without it. I've found some examples of `some_variable` to be: `MTIzNDU2Nzg5MA`, `MTIzNDU2Nzg5MQ` and `MTIzNDU2Nzg5Mg` diff --git a/.github/ISSUE_TEMPLATE/question---anything-else.md b/.github/ISSUE_TEMPLATE/question---anything-else.md new file mode 100644 index 00000000..89ccdc12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question---anything-else.md @@ -0,0 +1,8 @@ +--- +name: Question / Anything else +about: If you have a question about Facebook or fbchat, a meta-issue, or anything, + feel free to ask ;) + +--- + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..d5e735ae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,8 @@ +--- +name: Question +about: If you have a question about Facebook or fbchat, a meta-issue, or anything, + feel free to ask ;) + +--- + +