👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Shpee which is published on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
I don't want to read this whole thing, I just have a question!!!
What should I know before I get started?
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to leo@leodt.xyz.
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
If chat is more your speed, you can join the support Discord server:
- Join the support Discord server
- Even though Discord is a chat service, sometimes it can take several hours for me to be able to respond — please be patient!
- Use the
#helpchannel for questions or discussion about writing or contributing to Shpee - There are many other channels available, check the channel list
Please do not expect 5 star support or service on our repo, we are a small group who work on various different things. So far on 10 August 2019 we have only one developer working on this project.
It will take some time for us to review and respond to your issue tickets and pull requests, please be patient.
When we make a significant decision in how we maintain the project and what we can or cannot support, we will document it in the design-decisions.md file. If you have a question around how we do things, check to see if it is documented there. If it is not documented there, please contact us on Discord or by email and ask your question.
Bugs are tracked as GitHub issues. To submit, create an issue ticket and provide the following information:
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as much detail as possible.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If you're reporting that Shpee crashed, explain what caused the crash. Also give a copy of the bot log.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Include details about your configuration and environment:
- Which version of Shpee are you using? You can get the exact version by typing
infoin any server channel or DMs. - What's the name and version of the OS you're using?
- Which packages do you have installed? You can get that list by running
npm list -g --depth=0. - Are you using Shpee on multiple servers? If so, can you reproduce the problem on a single server?
Enhancement suggestions are tracked as GitHub issues. To submit, create an issue ticket and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Shpee which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most users and isn't something that can or should be implemented as an npm package.
- List some other Discord bots where this enhancement exists.
- Specify which version of Shpee you're using. You can get the exact version by typing
.infoin any server channel or DMs. - Specify the name and version of the OS you're using.
Unsure where to begin contributing to Shpee? You can start by looking through these good first issue and help-wanted issues:
- [Good first issues][good-first-issues] - issues which should only require a few lines of code, and a test or two.
- [Help wanted issues][help-wanted] - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
If you want to read about using Shpee or developing for Shpee, the Shpee docs are available on our GitHub wiki and as a standalone site soon.
The process described here has several goals:
- Maintain Shpee's quality
- Fix more important problems first
- Engage the community in working toward the best possible version of Shpee
- Enable a sustainable system for our maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- For contributing to the docs make sure your words are clear and easily understandable.
- Use Markdown.
- If you know how to use a host that there is no documentation for yet feel free to open a pull request.
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in. To help you find issues and pull requests, each label is listed with search links for finding open items with that label.
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.
Please open an issue if you have suggestions for new labels.
| Label name | DankZone/ShpeeBot 🔎 |
Description |
|---|---|---|
enhancement |
search | Feature requests. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | General feedback more than bug reports or feature requests. |
help-wanted |
search | The shpeebot core team would appreciate help from the community in resolving these issues. |
good-first-issue |
search | Less complex issues which would be good first issues to work on for users who want to contribute to Shpee. |
more-information-needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
duplicate |
search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | The shpeebot core team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | Issues which aren't valid (e.g. user errors). |
| Label name | DankZone/ShpeeBot 🔎 |
Description |
|---|---|---|
work-in-progress |
search | Pull requests which are still being worked on, more changes will follow. |
needs-review |
search | Pull requests which need code review, and approval from maintainers or shpeebot core team. |
under-review |
search | Pull requests being reviewed by maintainers or shpeebot core team. |
requires-changes |
search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs-testing |
search | Pull requests which need manual testing. |