5 changed files with 131 additions and 0 deletions
@ -0,0 +1,45 @@ |
|||
## Contributing to discord.py |
|||
|
|||
First off, thanks for taking the time to contribute. It makes the library substantially better. :+1: |
|||
|
|||
The following is a set of guidelines for contributing to the repository. These are guidelines, not hard rules. |
|||
|
|||
## 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) |
|||
|
|||
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. |
|||
|
|||
## Good Bug Reports |
|||
|
|||
Please be aware of the following things when filing bug reports. |
|||
|
|||
1. Don't open duplicate issues. Please search your issue to see if it has been asked already. Duplicate issues will be closed. |
|||
2. When filing a bug about exceptions or tracebacks, please include the *complete* traceback. Without the complete traceback the issue might be **unsolveable** and you will be asked to provide more information. |
|||
3. Make sure to provide enough information to make the issue workable. The issue template will generally walk you through the process but they are enumerated here as well: |
|||
- A **summary** of your bug report. This is generally a quick sentence or two to describe the issue in human terms. |
|||
- 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. |
|||
|
|||
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. |
|||
|
|||
## Submitting a Pull Request |
|||
|
|||
Submitting a pull request is fairly simple, just make sure it focuses on a single aspect and doesn't manage to have scope creep and it's probably good to go. It would be incredibly lovely if the style is consistent to those found in the project. This project follows PEP-8 guidelines (mostly) with a column limit of 125. |
|||
|
|||
### Git Commit Guidelines |
|||
|
|||
- 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. |
|||
- Commits regarding the commands extension must be prefixed with `[commands]` |
|||
|
|||
If you do not meet any of these guidelines, don't fret. Chances are they will be fixed upon rebasing but please do try to meet them to remove some of the workload. |
@ -0,0 +1,35 @@ |
|||
--- |
|||
name: Bug Report |
|||
about: Report broken or incorrect behaviour |
|||
--- |
|||
|
|||
### Summary |
|||
|
|||
<!-- A summary of your bug report --> |
|||
|
|||
### Reproduction Steps |
|||
|
|||
<!-- What you did to make it happen. Ideally there should be a short code snippet in this section to help reproduce the bug. --> |
|||
|
|||
### Expected Results |
|||
|
|||
<!-- What you expected to happen --> |
|||
|
|||
### Actual Results |
|||
|
|||
<!-- What actually happened. If there is a traceback, please show the entire thing. --> |
|||
|
|||
|
|||
### Checklist |
|||
|
|||
<!-- Put an x inside [ ] to check it --> |
|||
|
|||
- [ ] I have searched the open issues for duplicates. |
|||
- [ ] I have shown the entire traceback, if possible. |
|||
- [ ] I have removed my token from display, if visible. |
|||
|
|||
### System Information |
|||
|
|||
- discord.py version: |
|||
- Python version: |
|||
- Operating system: |
@ -0,0 +1,26 @@ |
|||
--- |
|||
name: Feature Request |
|||
about: Suggest a feature for this library |
|||
--- |
|||
|
|||
### The Problem |
|||
|
|||
<!-- |
|||
What problem is your feature trying to solve? What becomes easier or possible when this feature is implemented? |
|||
--> |
|||
|
|||
### The Ideal Solution |
|||
|
|||
<!-- |
|||
What is your ideal solution to the problem? What would you like this feature to do? |
|||
--> |
|||
|
|||
### The Current Solution |
|||
|
|||
<!-- |
|||
What is the current solution to the problem, if any? |
|||
--> |
|||
|
|||
### Summary |
|||
|
|||
<!-- A short summary of your feature request. --> |
@ -0,0 +1,11 @@ |
|||
--- |
|||
name: Question about the library |
|||
about: Please ask for help in Discord instead - https://discord.gg/r3sSKJJ |
|||
--- |
|||
|
|||
Generally speaking support questions are better answered in our Discord server. The response rate is faster and many people are willing to help. If you **really** feel like the question belongs here then feel free to delete this text and continue on. **Please do not open issues about asking how to implement a feature in your bot, these will be instantly closed.** |
|||
|
|||
Our support servers can be found here: |
|||
|
|||
Official server: https://discord.gg/r3sSKJJ |
|||
Discord API: https://discord.gg/discord-api |
@ -0,0 +1,14 @@ |
|||
### Summary |
|||
|
|||
<!-- What is this pull request for? Does it fix any issues? --> |
|||
|
|||
### Checklist |
|||
|
|||
<!-- Put an x inside [ ] to check it --> |
|||
|
|||
- [ ] 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 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, ...) |
Loading…
Reference in new issue