First Commit of this repository

This commit is contained in:
JoAnn Manges
2021-10-16 23:10:38 -04:00
parent afdb8fb379
commit 1ee27e21e8
17 changed files with 490 additions and 0 deletions

27
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@ -0,0 +1,27 @@
---
name: Bug report
about: Bug report for BTT_Octopus_Color_PIN_Diagram
title: "[BUG] (short description)"
labels: ''
assignees: ''
---
<!--
Please follow the instructions below. Failure to do so may result in your issue being closed.
### Instructions
1. Fill out every section of the template below.
2. Read and understand GadgetAngel's Code of Conduct. By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/GadgetAngel/BTT_Octopus_Color_PIN_Diagram/blob/main/.github/code-of-conduct.md
-->
### Bug Description
<!-- Describe the bug in this section. (You can remove this invisible comment.) -->
#### Additional Information
* Provide pictures or links to videos that clearly demonstrate the issue.

View File

@ -0,0 +1,31 @@
---
name: Feature request
about: Request a Feature.
title: "[FR] (feature request title)"
labels: ''
assignees: ''
---
<!--
Have you read GadgetAngel's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/GadgetAngel/BTT_Octopus_Color_PIN_Diagram/blob/main/.github/code-of-conduct.md
-->
### Description
<!-- Description of the requested feature -->
### Feature Workflow
<!-- Please describe the feature's you would like to see in the Manual -->
1. [First Change]
2. [Second Change]
3. [and so on...]
#### Additional Information
* Provide pictures or links that demonstrate a similar feature or concept.
* See [How Can I Contribute](#how-can-i-contribute) for additional guidelines.

119
.github/code-of-conduct.md vendored Normal file
View File

@ -0,0 +1,119 @@
# GadgetAngel Community Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and leaders pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level or type of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.
## Our Standards
We are committed to providing a friendly, safe and welcoming environment for
all.
Examples of behavior that contributes to creating a positive environment
include:
* Be kind and courteous to others
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Collaborating with other community members
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and sexual attention or advances
* The use of inappropriate images, including in a community member's avatar
* The use of inappropriate language, including in a community member's nickname
* Any spamming, flaming, baiting or other attention-stealing behavior
* Excessive or unwelcome helping; answering outside the scope of the question
asked
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate
The goal of the standards and moderation guidelines outlined here is to build
and maintain a respectful community. We ask that you dont just aim to be
"technically unimpeachable", but rather try to be your best self.
We value many things beyond technical expertise, including collaboration and
supporting others within our community. Providing a positive experience for
other community members can have a much more significant impact than simply
providing the correct answer.
## Our Responsibilities
Project leaders are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project leaders have the right and responsibility to remove, edit, or
reject messages, comments, commits, code, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any community member for other behaviors that they deem
inappropriate, threatening, offensive, or harmful.
## Moderation
Instances of behaviors that violate the GadgetAngel Community Code of Conduct
may be reported by any member of the community. Community members are
encouraged to report these situations, including situations they witness
involving other community members.
You may report in the following ways:
In any situation, you may send an email to <joannmanges@gmail.com>.
Email and direct message reports will be kept confidential.
These are the steps for upholding our communitys standards of conduct.
1. Any member of the community may report any situation that violates the
GadgetAngel Community Code of Conduct. All reports will be reviewed and
investigated.
2. If the behavior is an egregious violation, the community member who
committed the violation may be banned immediately, without warning.
3. Otherwise, moderators will first respond to such behavior with a warning.
4. Moderators follow a soft "three strikes" policy - the community member may
be given another chance, if they are receptive to the warning and change their
behavior.
5. If the community member is unreceptive or unreasonable when warned by a
moderator, or the warning goes unheeded, they may be banned for a first or
second offense. Repeated offenses will result in the community member being
banned.
## Scope
This Code of Conduct and the enforcement policies listed above apply to all
GadgetAngel Community venues. This includes but is not limited to any community
spaces (both public and private), the entire GadgetAngel Discord server, and
GadgetAngel GitHub repositories. Examples of GadgetAngel Community spaces include
but are not limited to meet-ups, audio chats on the GadgetAngel Discord, or
interaction at a conference.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. As a community
member, you are representing our community, and are expected to behave
accordingly.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>,
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
For other projects adopting the GadgetAngel Community Code of
Conduct, please contact the maintainers of those projects for enforcement.
If you wish to use this code of conduct for your own project, consider
explicitly mentioning your moderation policy or making a copy with your
own moderation policy so as to avoid confusion.

71
.github/contributing.md vendored Normal file
View File

@ -0,0 +1,71 @@
# 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](https://github.com/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
[Code of Conduct](./code-of-conduct.md)
[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
[How Can I Contribute?](#how-can-i-contribute)
* [Reporting Bugs](#reporting-bugs)
* [Suggesting Features or Changes](#suggesting-features-or-changes)
* [Pull Requests](#pull-requests)
## Code of Conduct
This project and everyone participating in it is governed by the [GadgetAngel of Conduct](./code-of-conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [GadgetAngel](mailto:joannmanges@gmail.com).
## 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.
* [Bigtreetech Octopus on Facebook](https://www.facebook.com/groups/531985571570025/)
## 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](#how-do-i-submit-a-good-bug-report). Fill out [the required template](./ISSUE_TEMPLATE/bug_report.md), 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](https://guides.github.com/features/issues/). Use the New Issue button to create an issue and provide the following information by filling in [the template](./ISSUE_TEMPLATE/bug_report.md).
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](#how-do-i-submit-a-good-feature-request). Fill in [the template](./ISSUE_TEMPLATE/feature_request.md).
#### How Do I Submit A (Good) Feature Request?
Feature Requests are tracked as [GitHub issues](https://guides.github.com/features/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](https://help.github.com/articles/creating-a-pull-request/) documentation.
* Fill in [the required template](./pull_request_template.md).
* 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.

27
.github/pull_request_template.md vendored Normal file
View File

@ -0,0 +1,27 @@
---
name: pull request
about: Open a pull request.
title: "Title (open a pull request Title)"
labels: ''
assignees: ''
---
### Requirements
* Filling out this template is required. Pull Requests without a clear description may be closed at the maintainers' discretion.
### Description
<!--
We must be able to understand your proposed change from this description. If we can't understand what the code will do from this description, the Pull Request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code recently, so please walk us through the concepts.
-->
### Benefits
<!-- What does this fix or improve? -->
### Related Issues
<!-- Whether this fixes a bug or fulfills a feature request, please list any related Issues here. -->