From 1c3103384cd95b3751fd8ef3dd78e3f0987e3758 Mon Sep 17 00:00:00 2001 From: thisiskeithb <13375512+thisiskeithb@users.noreply.github.com> Date: Fri, 10 Nov 2023 22:02:17 -0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Prusa=20AIO=20GitHub=20Administr?= =?UTF-8?q?ation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/FUNDING.yml | 5 +- .github/ISSUE_TEMPLATE/bug_report.yml | 49 +++++++---------- .github/ISSUE_TEMPLATE/config.yml | 19 ++----- .github/ISSUE_TEMPLATE/feature_request.yml | 14 ++--- .github/contributing.md | 63 +++++++++------------- .github/workflows/test-prusa-aio-build.yml | 46 ++++++++++++++++ 6 files changed, 106 insertions(+), 90 deletions(-) create mode 100644 .github/workflows/test-prusa-aio-build.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index a973242932..e70942d04b 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,3 +1,2 @@ -github: [thinkyhead] -patreon: thinkyhead -custom: ["https://www.thinkyhead.com/donate-to-marlin"] +github: [thisiskeithb] +ko_fi: thisiskeithb diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e0ee13af07..82ea90254c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,27 +1,27 @@ name: 🪲 Report a bug -description: Create a bug report to help improve Marlin Firmware +description: Create a bug report to help improve Prusa AIO Firmware title: "[BUG] (bug summary)" -labels: ["Bug: Potential ?"] +labels: ["bug"] body: - type: markdown attributes: value: > - Do you want to ask a question? Are you looking for support? Please use one of the [support links](https://github.com/MarlinFirmware/Marlin/issues/new/choose). + Do you want to ask a question? Are you looking for support? Please use one of the [support links](https://github.com/thisiskeithb/PrusaAIO/issues/new/choose). - type: markdown attributes: value: | - **Thank you for reporting a bug in Marlin Firmware!** + **Thank you for reporting a bug in Prusa AIO Firmware!** ## Before Reporting a Bug - - Read and understand Marlin's [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/bugfix-2.1.x/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect. + - Read and understand Prusa AIO's [Code of Conduct](https://github.com/thisiskeithb/PrusaAIO/blob/prusa-aio-bugfix-2.1.x/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect. - - Test with the [`bugfix-2.1.x` branch](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.1.x.zip) to see whether the issue still exists. + - Test with the [`prusa-aio-bugfix-2.1.x` branch](https://github.com/thisiskeithb/PrusaAIO/archive/prusa-aio-bugfix-2.1.x.zip) to see whether the issue still exists. ## Instructions - Please follow the instructions below. Failure to do so may result in your issue being closed. See [Contributing to Marlin](https://github.com/MarlinFirmware/Marlin/blob/bugfix-2.1.x/.github/contributing.md) for additional guidelines. + Please follow the instructions below. Failure to do so may result in your issue being closed. See [Contributing to Prusa AIO](https://github.com/thisiskeithb/PrusaAIO/blob/prusa-aio-bugfix-2.1.x/.github/contributing.md) for additional guidelines. 1. Provide a good title starting with [BUG]. 2. Fill out all sections of this bug report form. @@ -29,10 +29,10 @@ body: - type: dropdown attributes: - label: Did you test the latest `bugfix-2.1.x` code? + label: Did you test the latest `prusa-aio-bugfix-2.1.x` code? description: >- Always try the latest code to make sure the issue you are reporting is not already fixed. To download - the latest code just [click this link](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.1.x.zip). + the latest code just [click this link](https://github.com/thisiskeithb/PrusaAIO/archive/prusa-aio-bugfix-2.1.x.zip). options: - Yes, and the problem still exists. - No, but I will test it now! @@ -54,7 +54,7 @@ body: When pasting formatted text don't forget to put ` ``` ` (on its own line) before and after to make it readable. placeholder: | - Marlin doesn't work. + Prusa AIO doesn't work. validations: required: true @@ -93,25 +93,20 @@ body: - type: input attributes: - label: Version of Marlin Firmware - description: "See the About Menu on the LCD or the output of `M115`. NOTE: For older releases we only patch critical bugs." + label: Version of Prusa AIO Firmware + description: "See the About Menu on the LCD or the output of `M115`." validations: required: true - - type: input - attributes: - label: Printer model - description: Creality Ender-3, Prusa mini, or Kossel Delta? - - type: input attributes: label: Electronics - description: Stock electronics, upgrade board, or something else? + description: SKR 3.0, 2.0, Robin Nano V3, etc., or something else? - type: input attributes: label: LCD/Controller - description: Some Marlin behaviors are determined by the controller. Describe your LCD/Controller model and version. + description: Some Prusa AIO behaviors are determined by the controller. Describe your LCD/Controller model and version. - type: input attributes: @@ -123,23 +118,19 @@ body: label: Bed Leveling description: What kind of bed leveling compensation are you using? options: - - UBL Bilinear mesh - ABL Bilinear mesh - - ABL Linear grid - - ABL 3-point - - MBL Manual Bed Leveling - - No Bed Leveling + - UBL Bilinear mesh - type: dropdown attributes: label: Your Slicer - description: Do you use Slic3r, Prusa Slicer, Simplify3D, IdeaMaker...? + description: Do you use PrusaSlicer, Cura, IdeaMaker, or something else? options: - - Slic3r - - Simplify3D - - Prusa Slicer + - PrusaSlicer - IdeaMaker - Cura + - Slic3r + - Simplify3D - Other (explain below) - type: dropdown @@ -164,7 +155,7 @@ body: attributes: label: Don't forget to include options: - - label: A ZIP file containing your `Configuration.h` and `Configuration_adv.h`. + - label: A ZIP file containing your `Prusa_AIO_Configuration.h`. required: true - type: markdown diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1fe68966fb..b44c4e8d1c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,20 +1,11 @@ blank_issues_enabled: false contact_links: + - name: 🔗 Prusa AIO Discussion Forum + url: https://github.com/thisiskeithb/PrusaAIO/discussions + about: A searchable Prusa AIO Firmware forum. - name: 📖 Marlin Documentation url: https://marlinfw.org/ about: Lots of documentation on installing and using Marlin. - - name: 👤 MarlinFirmware Facebook group - url: https://www.facebook.com/groups/1049718498464482 - about: Please ask and answer questions here. - - name: 🕹 Marlin on Discord - url: https://discord.gg/n5NJ59y - about: Join the Discord server for support and discussion. - - name: 🔗 Marlin Discussion Forum - url: https://reprap.org/forum/list.php?415 - about: A searchable web forum hosted by RepRap dot org. - - name: 📺 Marlin Videos on YouTube - url: https://www.youtube.com/results?search_query=marlin+firmware - about: Tutorials and more from Marlin users all around the world. Great for new users! - name: 💸 Want to donate? - url: https://www.thinkyhead.com/donate-to-marlin - about: Please take a look at the various options to support Marlin Firmware's development financially! + url: https://github.com/sponsors/thisiskeithb + about: Please take a look at the various options to support thisiskeithb & Prusa AIO's development financially! diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 2e8607142c..30025117ac 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,30 +1,30 @@ name: ✨ Request a feature -description: Request a new Marlin Firmware feature +description: Request a new Prusa AIO Firmware feature title: "[FR] (feature summary)" -labels: ["T: Feature Request"] +labels: ["enhancement"] body: - type: markdown attributes: value: > - Do you want to ask a question? Are you looking for support? Please use one of the [support links](https://github.com/MarlinFirmware/Marlin/issues/new/choose). + Do you want to ask a question? Are you looking for support? Please use one of the [support links](https://github.com/thisiskeithb/PrusaAIO/issues/new/choose). - type: markdown attributes: value: > - **Thank you for requesting a new Marlin Firmware feature!** + **Thank you for requesting a new Prusa AIO Firmware feature!** ## Before Requesting a Feature - - Read and understand Marlin's [Code of Conduct](https://github.com/MarlinFirmware/Marlin/blob/master/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect. + - Read and understand Prusa AIO's [Code of Conduct](https://github.com/thisiskeithb/PrusaAIO/blob/prusa-aio-bugfix-2.1.x/.github/code_of_conduct.md). You are expected to comply with it, including treating everyone with respect. - - Check the latest [`bugfix-2.1.x` branch](https://github.com/MarlinFirmware/Marlin/archive/bugfix-2.1.x.zip) to see if the feature already exists. + - Test with the [`prusa-aio-bugfix-2.1.x` branch](https://github.com/thisiskeithb/PrusaAIO/archive/prusa-aio-bugfix-2.1.x.zip) to see if the feature already exists. - Before you proceed with your request, please consider if it is necessary to make it into a firmware feature, or if it may be better suited for a slicer or host feature. - type: textarea attributes: label: Is your feature request related to a problem? Please describe. - description: A clear description of the problem (e.g., "I need X but Marlin can't do it [...]"). + description: A clear description of the problem (e.g., "I need X but Prusa AIO can't do it [...]"). - type: textarea attributes: diff --git a/.github/contributing.md b/.github/contributing.md index c9b31998e9..c6e64c4f79 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -1,8 +1,8 @@ -# Contributing to Marlin +# Contributing to Prusa AIO -Thanks for your interest in contributing to Marlin Firmware! +Thanks for your interest in contributing to Prusa AIO Firmware! -The following is a set of guidelines for contributing to Marlin, hosted by the [MarlinFirmware Organization](https://github.com/MarlinFirmware) 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. +The following is a set of guidelines for contributing to Prusa AIO, hosted by [thisiskeithb](https://github.com/thisiskeithb) 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 @@ -26,33 +26,23 @@ The following is a set of guidelines for contributing to Marlin, hosted by the [ ## Code of Conduct -This project and everyone participating in it is governed by the [Marlin Code of Conduct](code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior by following GitHub's [reporting abuse or spam article](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam). +This project and everyone participating in it is governed by the [Prusa AIO Code of Conduct](code_of_conduct.md). By participating, you are expected to uphold this code. Please report unacceptable behavior by following GitHub's [reporting abuse or spam article](https://docs.github.com/en/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam). ## 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. -We have a Message Board and a Facebook group where our knowledgable user community can provide helpful advice if you have questions. - -- [Marlin Documentation](https://marlinfw.org) - Official Marlin documentation -- Facebook Group ["Marlin Firmware"](https://www.facebook.com/groups/1049718498464482/) -- RepRap.org [Marlin Forum](https://forums.reprap.org/list.php?415) -- Facebook Group ["Marlin Firmware for 3D Printers"](https://www.facebook.com/groups/3Dtechtalk/) -- [Marlin Configuration](https://www.youtube.com/results?search_query=marlin+configuration) on YouTube - -If chat is more your speed, you can join the MarlinFirmware Discord server: - -* Use the link https://discord.gg/n5NJ59y to join up as a General User. -* Even though our Discord is pretty active, it may take a while for community members to respond — please be patient! -* Use the `#general` channel for general questions or discussion about Marlin. -* Other channels exist for certain topics or are limited to Patrons. Check the channel list. +* [Prusa AIO Wiki](https://github.com/thisiskeithb/PrusaAIO/wiki/) — Includes wiring information, recommended motherboard & LCD cases, purchase links for supported hardware, and more! +* [Prusa AIO Discussions](https://github.com/thisiskeithb/PrusaAIO/discussions) +* [Prusa Bear Upgrade Facebook group](https://facebook.com/groups/prusabearupgrade/) +* [Prusa Community Facebook group](https://facebook.com/groups/675831176090951/) ## How Can I Contribute? ### Reporting Bugs -This section guides you through submitting a Bug Report for Marlin. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. +This section guides you through submitting a Bug Report for Prusa AIO. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. Before creating a Bug Report, please test the "nightly" development branch, 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](#how-do-i-submit-a-good-bug-report). Fill out [the required template](ISSUE_TEMPLATE/bug_report.yml), the information it asks for helps us resolve issues faster. @@ -66,7 +56,7 @@ Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). 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 Marlin, e.g. which command exactly you used in the terminal, or how you started Marlin otherwise. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Marlin command, and if so which one? +* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started Prusa AIO, e.g. which command exactly you used in the terminal, or how you started Prusa AIO otherwise. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Prusa AIO command, and if so which one? * **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 or log output in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). * **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.** @@ -78,27 +68,25 @@ Explain the problem and include additional details to help maintainers reproduce Provide more context: * **Can you reproduce the problem with a minimum of options enabled?** -* **Did the problem start happening recently** (e.g. after updating to a new version of Marlin) or was this always a problem? -* If the problem started happening recently, **can you reproduce the problem in an older version of Marlin?** What's the most recent version in which the problem doesn't happen? You can download older versions of Marlin from [the releases page](https://github.com/MarlinFirmware/Marlin/releases). +* **Did the problem start happening recently** (e.g. after updating to a new version of Prusa AIO) or was this always a problem? +* If the problem started happening recently, **can you reproduce the problem in an older version of Prusa AIO?** What's the most recent version in which the problem doesn't happen? You can download older versions of Prusa AIO from [the releases page](https://github.com/thisiskeithb/PrusaAIO/releases). * **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 Marlin are you using?** Marlin's exact version and build date can be seen in the startup message when a host connects to Marlin, or in the LCD Info menu (if enabled). +* **Which version of Prusa AIO are you using?** Prusa AIO's exact version and build date can be seen in the startup message when a host connects to Prusa AIO, or in the LCD Info menu (if enabled). * **What kind of 3D Printer and electronics are you using**? * **What kind of add-ons (probe, filament sensor) do you have**? -* **Include your Configuration files.** Make a ZIP file containing `Configuration.h` and `Configuration_adv.h` and drop it on your reply. +* **Include your Configuration files.** Make a ZIP file containing `Prusa_AIO_Configuration.h` and drop it on your reply. ### Suggesting Features or Changes -This section guides you through submitting a suggestion for Marlin, 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 a suggestion, please check [this list](https://github.com/MarlinFirmware/Marlin/issues?q=is%3Aopen+is%3Aissue+label%3A%22T%3A+Feature+Request%22) 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](#how-do-i-submit-a-good-feature-request). Fill in [the template](ISSUE_TEMPLATE/feature_request.yml), including the steps that you imagine you would take if the feature you're requesting existed. +This section guides you through submitting a suggestion for Prusa AIO, 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 Submitting a Feature Request -* **Check the [Marlin website](https://marlinfw.org/)** for tips — you might discover that the feature is already included. Most importantly, check if you're using [the latest version of Marlin](https://github.com/MarlinFirmware/Marlin/releases) and if you can get the desired behavior by changing [Marlin's config settings](https://marlinfw.org/docs/configuration/configuration.html). -* **Perform a [cursory search](https://github.com/MarlinFirmware/Marlin/issues?q=is%3Aopen+is%3Aissue+label%3A%22T%3A+Feature+Request%22)** 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. +* **Check the [Prusa AIO repository](https://github.com/thisiskeithb/PrusaAIO)** for tips — you might discover that the feature is already included. Most importantly, check if you're using [the latest version of Prusa AIO](https://github.com/thisiskeithb/PrusaAIO/releases) and if you can get the desired behavior by changing [Prusa AIO's config settings](../Marlin/Prusa_AIO_Configuration.h). +* **Perform a cursory search of the [issue queue](https://github.com/thisiskeithb/PrusaAIO/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) and [discussions](https://github.com/thisiskeithb/PrusaAIO/discussions/categories/ideas)** as you might find out that you don't need to create one. If it has, add a comment to the existing issue instead of opening a new one. #### How Do I Submit A (Good) Feature Request? @@ -108,25 +96,26 @@ Feature Requests are tracked as [GitHub issues](https://guides.github.com/featur * **Provide a step-by-step description of the requested feature** in as much detail as possible. * **Provide specific examples to demonstrate the steps**. * **Describe the current behavior** and **explain which behavior you expected to see instead** and why. -* **Include screenshots and links to videos** which demonstrate the feature or point out the part of Marlin to which the request is related. -* **Explain why this feature would be useful** to most Marlin users. +* **Include screenshots and links to videos** which demonstrate the feature or point out the part of Prusa AIO to which the request is related. +* **Explain why this feature would be useful** to most Prusa AIO users. * **Name other firmwares that have this feature, if any.** ### Your First Code Contribution -Unsure where to begin contributing to Marlin? You can start by looking through these `good-first-issue` and `help-wanted` issues: +Unsure where to begin contributing to Prusa AIO? You can start by looking through issues tagged with `good first issue`, `help wanted`, or discussions: -* [Beginner issues][good-first-issue] - issues which should only require a few lines of code, and a test or two. -* [Help Wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues. +* Beginner issues ([good first issue](https://github.com/thisiskeithb/PrusaAIO/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)): issues which should only require a few lines of code, and a test or two. +* Help Wanted issues ([help wanted](https://github.com/thisiskeithb/PrusaAIO/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)): issues which should be a bit more involved than beginner issues. +* [Discussions](https://github.com/thisiskeithb/PrusaAIO/discussions): A casual place to discuss issues or suggest improvements. ### Pull Requests -Pull Requests should always be targeted to working branches (e.g., `bugfix-2.1.x` and/or `bugfix-1.1.x`) and never to release branches (e.g., `2.0.x` and/or `1.1.x`). If this is your first Pull Request, please read our [Guide to Pull Requests](https://marlinfw.org/docs/development/getting_started_pull_requests.html) and Github's [Pull Request](https://help.github.com/articles/creating-a-pull-request/) documentation. +Pull Requests should always be targeted to working branches (e.g., `prusa-aio-bugfix-2.1.x`) and never to release branches (e.g., `prusa-aio-2.1.x`). If this is your first Pull Request, please see 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. -* Follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on our website. +* Follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on Marlin Firmware's website. * Document new code with clear and concise comments. * End all files with a newline. @@ -141,7 +130,7 @@ Pull Requests should always be targeted to working branches (e.g., `bugfix-2.1.x ### C++ Coding Standards -* Please read and follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on our website. Failure to follow these guidelines will delay evaluation and acceptance of Pull Requests. +* Please read and follow the [Coding Standards](https://marlinfw.org/docs/development/coding_standards.html) posted on Marlin Firmware's website. Failure to follow these guidelines will delay evaluation and acceptance of Pull Requests. ### Documentation diff --git a/.github/workflows/test-prusa-aio-build.yml b/.github/workflows/test-prusa-aio-build.yml new file mode 100644 index 0000000000..a31fd26501 --- /dev/null +++ b/.github/workflows/test-prusa-aio-build.yml @@ -0,0 +1,46 @@ +# +# test-prusa-aio-build.yml +# Basic test build to catch Prusa AIO compile errors +# + +name: Prusa AIO CI + +on: + pull_request: + paths-ignore: + - config/** + - data/** + - docs/** + - '**/*.md' + push: + paths-ignore: + - config/** + - data/** + - docs/** + - '**/*.md' + +jobs: + test_builds: + name: Test Build + if: github.repository == 'thisiskeithb/PrusaAIO' + + runs-on: ubuntu-latest + + steps: + - name: Check out PrusaAIO + uses: actions/checkout@v3 + + - name: Select Python 3.7 + uses: actions/setup-python@v3 + with: + python-version: '3.7' # Version range or exact version of a Python version to use, using semvers version range syntax. + architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified + + - name: Install PlatformIO + run: | + pip install -U platformio + pio upgrade --dev + pio pkg update --global + + - name: Build Marlin + run: pio run