First off, thanks for taking the time to contribute! ❤️
Please make sure to read the relevant sections before making your contribution. It will make it a lot easier for us and maintain a clean codebase. We look forward to your contributions. 🎉
- I Have a Question
- I Want To Contribute
- Reporting Bugs
- Suggesting Enhancements
- Your First Code Contribution
- Improving The Documentation
- Styleguides
- Commit Messages
- Join The Project Team
If able, contact us in the Discord DMs listed in PRIVACY.md or via email at [email protected]. If not, create an issue:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions.
We will take care of the issue whenever we read that tab (never).
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license (MIT).
We ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps before reporting an issue to make it easier for everyone.
- Make sure you're running the latest version of the bot.
- Determine if your issue really is a bug and not an issue on your side, such as outdated packages, own modifications or similar. If you are looking for support, you might want to check this section).
- Check that there is not already a bug report existing for your bug or error in the issues tab.
- Collect information about the bug:
- Logs (logs/debug.log and logs/errors.log)
- Operating System / Environment
- Node.js and npm versions
- The input that caused the issue
- Steps to reproduce the bug
You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [email protected].
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- We will try to reproduce the issue with your provided steps.
- If the team is able to reproduce the issue, it will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for Mao Zedong, including completely new features and minor improvements to existing functionality.
- Make sure that you are using the latest version.
- 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.
- Think if your idea is within the project's scope, if not, make a fork.
Enhancement suggestions are tracked as GitHub issues.
- Use alear and descriptive title
- Provide as many details as possible
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots or screen recordings which help you demonstrate the steps or point out the part which the suggestion is related to. You can use LICEcap to record GIFs on macOS and Windows, and the built-in screen recorder in GNOME or SimpleScreenRecorder on Linux.
- Explain why this enhancement would be useful to most users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
TBA
TBA
TBA
TBA