4.2 KiB
Contributing to BTT_Octopus_Color_PIN_Diagram
Thanks for your interest in contributing to BTT_Octopus_Color_PIN_Diagram!
The following is a set of guidelines for contributing to BTT_Octopus_Color_PIN_Diagram, hosted by the GadgetAngel 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.
Table Of Contents
I don't want to read this whole thing, I just have a question!!!
Code of Conduct
This project and everyone participating in it is governed by the GadgetAngel of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to GadgetAngel.
I don't want to read this whole thing I just have a question!!!
Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.
Bigtreetech hasFacebook groups where our knowledgable user community can provide helpful advice if you have questions.
How Can I Contribute?
Reporting Bugs
This section guides you through submitting a Bug Report for BTT_Octopus_Color_PIN_Diagram. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
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: Regressions can happen. If you find a Closed issue that seems like your issue, go ahead and open a new issue and include a link to the original issue in the body of your new one. All you need to create a link is the issue number, preceded by #. For example, #8888.
How Do I Submit A (Good) Bug Report?
Bugs are tracked as GitHub issues. Use the New Issue button to create an issue 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 error in the manual in as many details as possible.
- Include screenshots, links to videos, etc. which clearly demonstrate the problem.
Suggesting Features or Changes
This section guides you through submitting a suggestion for BTT_Octopus_Color_PIN_Diagram, including completely new features. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template.
How Do I Submit A (Good) Feature Request?
Feature Requests are tracked as GitHub issues. Please follow these guidelines in your request:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Include screenshots and links to videos which demonstrate the feature or point out the part of the "Color PIN Diagram" to which the request is related.
- Explain why this feature would be useful to most readers.
Pull Requests
Pull Requests should always be targeted to working branches (e.g., master
). If this is your first Pull Request, please read Github's Pull Request documentation.
- Fill in the required template.
- Don't include issue numbers in the PR title.
- Include pictures, diagrams, and links to videos in your Pull Request to demonstrate your changes, if needed.