diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 68f037c31..9753d8927 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,12 +6,7 @@ The following is a set of guidelines for contributing to the repository. These a ## This is too much to read! I want to ask a question! -Generally speaking questions are better suited in our resources below. - -- The official support server: https://discord.gg/r3sSKJJ -- The Discord API server under #python_discord-py: https://discord.gg/discord-api -- [The FAQ in the documentation](https://discordpy.readthedocs.io/en/latest/faq.html) -- [StackOverflow's `discord.py` tag](https://stackoverflow.com/questions/tagged/discord.py) +Generally speaking questions are better suited in the repo discussions. Please try your best not to ask questions in our issue tracker. Most of them don't belong there unless they provide value to a larger audience. @@ -26,7 +21,7 @@ Please be aware of the following things when filing bug reports. - Guidance on **how to reproduce the issue**. Ideally, this should have a small code sample that allows us to run and see the issue for ourselves to debug. **Please make sure that the token is not displayed**. If you cannot provide a code snippet, then let us know what the steps were, how often it happens, etc. - Tell us **what you expected to happen**. That way we can meet that expectation. - Tell us **what actually happens**. What ends up happening in reality? It's not helpful to say "it fails" or "it doesn't work". Say *how* it failed, do you get an exception? Does it hang? How are the expectations different from reality? - - Tell us **information about your environment**. What version of discord.py are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use. + - Tell us **information about your environment**. What version of discord.py-self are you using? How was it installed? What operating system are you running on? These are valuable questions and information that we use. If the bug report is missing this information then it'll take us longer to fix the issue. We will probably ask for clarification, and barring that if no response was given then the issue will be closed. @@ -36,7 +31,7 @@ Submitting a pull request is fairly simple, just make sure it focuses on a singl ### Git Commit Guidelines -- Use present tense (e.g. "Add feature" not "Added feature") +- Try to use present tense (e.g. "Add feature" not "Added feature") - Limit all lines to 72 characters or less. - Reference issues or pull requests outside of the first line. - Please use the shorthand `#123` and not the full URL. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index eabf5c071..034658e4d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -5,10 +5,7 @@ body: - type: markdown attributes: value: > - Thanks for taking the time to fill out a bug. - If you want real-time support, consider joining our Discord at https://discord.gg/r3sSKJJ instead. - - Please note that this form is for bugs only! + Thanks for taking the time to fill out a bug report! - type: input attributes: label: Summary @@ -19,35 +16,27 @@ body: attributes: label: Reproduction Steps description: > - What you did to make it happen. + How did you make it happen? validations: required: true - type: textarea attributes: - label: Minimal Reproducible Code + label: Code description: > - A short snippet of code that showcases the bug. + Relevant code that shows the bug. render: python - type: textarea attributes: label: Expected Results description: > - What did you expect to happen? + What is supposed to happen? validations: required: true - type: textarea attributes: label: Actual Results description: > - What actually happened? - validations: - required: true - - type: input - attributes: - label: Intents - description: > - What intents are you using for your bot? - This is the `discord.Intents` class you pass to the client. + What is actually happening? validations: required: true - type: textarea @@ -55,24 +44,21 @@ body: label: System Information description: > Run `python -m discord -v` and paste this information below. - - This command required v1.1.0 or higher of the library. If this errors out then show some basic - information involving your system such as operating system and Python version. validations: required: true - type: checkboxes attributes: label: Checklist description: > - Let's make sure you've properly done due dilligence when reporting this issue! + Let's make sure this issue is valid! options: - label: I have searched the open issues for duplicates. required: true - - label: I have shown the entire traceback, if possible. + - label: I have shared the entire traceback. required: true - - label: I have removed my token from display, if visible. + - label: I am using a user token (and it isn't visible in the code). required: true - type: textarea attributes: - label: Additional Context - description: If there is anything else to say, please do so here. + label: Additional Information + description: Put any extra context, weird configurations, or other important info here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7934e4a85..8b71d28e9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - - name: Ask a question - about: Ask questions and discuss with other users of the library. - url: https://github.com/Rapptz/discord.py/discussions - - name: Discord Server - about: Use our official Discord server to ask for help and questions as well. - url: https://discord.gg/r3sSKJJ + - name: Get help + url: https://github.com/dolfies/discord.py-self/discussions/new?category=help + about: Ask a question on our help page (*not* for bug reports). + - name: Suggest a feature + url: https://github.com/dolfies/discord.py-self/discussions/new?category=ideas + about: Suggest new features for the library! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 55941f4e1..18a34d101 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,13 +2,12 @@ -## Checklist - +## General Info - [ ] If code changes were made then they have been tested. - - [ ] I have updated the documentation to reflect the changes. -- [ ] This PR fixes an issue. + +- [ ] This PR fixes an issue (please put issue # in summary). - [ ] This PR adds something new (e.g. new method or parameters). - [ ] This PR is a breaking change (e.g. methods or parameters removed/renamed) - [ ] This PR is **not** a code change (e.g. documentation, README, ...)