Preparing the repository

Author: mriscoc

.devcontainer/Dockerfile

@@ -0,0 +1,29 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.187.0/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
+ARG VARIANT="3.9.0-buster"
+FROM python:${VARIANT}
+
+# [Option] Install Node.js
+ARG INSTALL_NODE="true"
+ARG NODE_VERSION="lts/*"
+RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+
+
+RUN pip install -U https://github.com/platformio/platformio-core/archive/develop.zip
+RUN platformio update
+# To get the test platforms
+RUN pip install PyYaml
+#ENV PATH /code/buildroot/bin/:/code/buildroot/tests/:${PATH}

.devcontainer/devcontainer.json

@@ -0,0 +1,51 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.187.0/containers/python-3
+{
+  "name": "Python 3",
+  "build": {
+    "dockerfile": "Dockerfile",
+    "context": "..",
+    "args": {
+      // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
+      "VARIANT": "3.9.0-buster",
+      // Options
+      "INSTALL_NODE": "false",
+      "NODE_VERSION": "lts/*"
+    }
+  },
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {
+    "python.pythonPath": "/usr/local/bin/python",
+    "python.languageServer": "Pylance",
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
+    "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+    "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+    "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+    "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+    "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+    "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+    "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+    "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+    "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
+  },
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [
+    "ms-python.python",
+    "ms-python.vscode-pylance",
+    "platformio.platformio-ide",
+    "marlinfirmware.auto-build",
+    "editorconfig.editorconfig"
+  ],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "pip3 install --user -r requirements.txt",
+
+  // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  // "remoteUser": "vscode"
+}

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+custom: ["https://www.paypal.com/paypalme/mriscoc"]
+patreon: mriscoc

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,169 @@
+name: 🐛 Report a bug
+description: Create a bug report to help improve the Professional Firmware
+title: "[BUG] (bug summary)"
+body:
+  - type: markdown
+    attributes:
+      value: >
+        Do you want to ask a question? Are you looking for support or a feature request? Please use the [Discussions page](https://github.com/mriscoc/Ender3V2S1/discussions).
+
+  - type: markdown
+    attributes:
+      value: |
+        **Thank you for reporting a bug in Professional Firmware!**
+
+        ## Before Reporting a Bug
+
+        - Read and understand [Code of Conduct](https://github.com/mriscoc/Ender3V2S1/blob/Ender3V2S1-Released/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect.
+
+         - Try the latest precompiled versions to make sure the issue you are reporting is not caused by your custom configuration.
+
+        - If you compile a custom version, test your configuration with the Marlin [`bugfix-2.1.x` branch](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.1.x.zip) to see whether the issue also exists in Marlin.
+
+        ## Instructions
+
+        Please follow the instructions below. Failure to do so may result in your issue being closed. See [Contributing to Professional Firmware](https://github.com/mriscoc/Ender3V2S1/blob/Ender3V2S1-Released/.github/contributing.md) for additional guidelines.
+
+        1. Provide a good title not a general one.
+        2. Fill out all sections of this bug report form.
+        3. Attach configuration files if applicable.
+
+  - type: dropdown
+    attributes:
+      label: Did you test with a precompiled firmware?
+      description: >-
+        Always try the latest precompiled version to make sure the issue you are reporting is not caused by your custom configuration.
+      options:
+        - Yes, and the problem still exists.
+        - No, but I will test it now!
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        # Bug Details
+
+  - type: textarea
+    attributes:
+      label: Bug Description
+      description: >-
+        Describe the bug in this section. Tell us what you were trying to do and what
+        happened that you did not expect. Provide a clear and concise description of the
+        problem and include as many details as possible.
+
+        When pasting formatted text don't forget to put ` ``` ` (on its own line) before and after to make it readable.
+      placeholder: |
+        Firmware doesn't work.
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Bug Timeline
+      description: Is this a new bug or an old issue? When did it first start?
+
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: >-
+        What did you expect to happen?
+      placeholder: I expected it to move left.
+
+  - type: textarea
+    attributes:
+      label: Actual behavior
+      description: What actually happened instead?
+      placeholder: It moved right instead of left.
+
+  - type: textarea
+    attributes:
+      label: Steps to Reproduce
+      description: >-
+        Please describe the steps needed to reproduce the issue.
+      placeholder: |
+        1. [First Step] ...
+        2. [Second Step] ...
+        3. [and so on] ...
+
+  - type: markdown
+    attributes:
+      value: |
+        # Your Setup
+
+  - type: input
+    attributes:
+      label: Version of Professional Firmware
+      description: "See the Control/Info Menu on the Screen or the output of `M115`."
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: Printer model
+      description: Creality Ender 3V2, S1, F4/F1?
+
+  - type: input
+    attributes:
+      label: Electronics
+      description: Board 4.2.2, 4.2.7, SKR Mini?
+
+  - type: input
+    attributes:
+      label: Add-ons
+      description: Please list any hardware add-ons that could be involved.
+
+  - type: dropdown
+    attributes:
+      label: Bed Leveling
+      description: What kind of bed leveling compensation are you using?
+      options:
+        - UBL Bilinear mesh
+        - ABL Bilinear mesh
+        - MBL Manual Bed Leveling
+
+  - type: dropdown
+    attributes:
+      label: Your Slicer
+      description: Do you use Slic3r, Prusa Slicer, Simplify3D, IdeaMaker...?
+      options:
+        - Slic3r
+        - Simplify3D
+        - Prusa Slicer
+        - IdeaMaker
+        - Cura
+        - Other (explain below)
+
+  - type: dropdown
+    attributes:
+      label: Host Software
+      description: Do you use OctoPrint, Repetier Host, Pronterface...?
+      options:
+        - SD Card (headless)
+        - Repetier Host
+        - OctoPrint
+        - Pronterface
+        - Cura
+        - Same as my slicer
+        - Other (explain below)
+
+  - type: markdown
+    attributes:
+      value: |
+        # Attachments
+
+  - type: markdown
+    attributes:
+      value: |
+        ### Optional items to include:
+        - 'Log output from the host. (`M111 S247` for maximum logging.)'
+        - Images or videos demonstrating the problem, if it helps to make it clear.
+        - A G-Code file that exposes the problem, if not affecting _all_ G-code.
+
+  - type: textarea
+    attributes:
+      label: Additional information & file uploads
+      description: >-
+        If you've made any other modifications to the firmware, please describe them in detail.
+
+        When pasting formatted text don't forget to put ` ``` ` (on its own line) before and after to make it readable.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📖 Professional Firmware Documentation
+    url: https://github.com/mriscoc/Ender3V2S1/wiki
+    about: Lots of documentation about firmware settings and features.
+  - name: 📖 Marlin Documentation
+    url: https://marlinfw.org/
+    about: Lots of documentation on installing and using Marlin.
+  - name: 👤 Professional Firmware Facebook group
+    url: https://www.facebook.com/groups/513889302986197
+    about: Please ask and answer questions here.
+  - name: 💸 Want to donate?
+    url: https://www.paypal.com/paypalme/mriscoc
+    about: Your contribution to this project is always welcome!

.github/code_of_conduct.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers 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 of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* 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 unwelcome sexual attention or advances
+* 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 in a professional setting
+
+## Our Responsibilities
+
+Project maintainers 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 maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/