👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Miscord and its packages, which are hosted in the Miscord Organization 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!!!
Note: You'll get faster results by using the resources below.
We have an official Discord server where the community chimes in with helpful advice if you have questions.
Also, take a look at our FAQ (#faq on Discord or wiki/FAQ)
This section guides you through submitting a bug report for Miscord. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Check the FAQ and try changing log level. You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem in the latest version of Miscord.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. You can create an issue in the miscord repository and provide the following information by filling in the template.
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 many details as possible. For example, start by explaining how you started Miscord, e.g. which command exactly you used in the terminal, or how you started Miscord otherwise.
- 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.
- If you're reporting that Miscord crashed, include a crash report with a stack trace from the operating system. Log file should be in folder
logs/alongside your config. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist. - 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.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of Miscord) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Miscord? What's the most recent version in which the problem doesn't happen? You can download older versions of Miscord from the releases page or with
npm install -g miscord@version. - Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of Miscord are you using? You can get the exact version by running
miscord -vin your terminal, or by checking the Discord bot's Presence. - What's the name and version of the OS you're using
- Which version of NPM you're using (ignore for binary)
This section guides you through submitting an enhancement suggestion for Miscord, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Check the beta version — you might discover that the enhancement is already available. Most importantly, check if you're using the latest version of Miscord.
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. You can create an issue in the miscord repository 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.
- Explain why this enhancement would be useful to most Miscord users.
- Specify which version of Miscord you're using. You can get the exact version by running
miscord -vin your terminal, or by checking the Discord bot's Presence. - Specify the name and version of the OS you're using.
Unsure where to begin contributing to Miscord? You can start by looking through these beginner and help-wanted issues:
- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by activity.
The process described here has several goals:
- Maintain Miscord's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Miscord
- Enable a sustainable system for Miscord's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow the styleguides
- Make sure you're creating a PR to
devand notmaster - 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.
- Start the commit message with an applicable emoji
- Use the past tense ("added feature", not "add feature")
- Don't capitalize ("added feature", not "Added feature")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
All JavaScript must adhere to JavaScript Standard Style.
Heavily inspired by Atom's Contributing page