Initial commit

Author: wjakobczyk-polyend

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve the Preset.
+title: "[Firmware version] Bug title"
+labels: bug
+assignees: ""
+---
+## Hi, sorry you had trouble!
+
+### Steps to reproduce
+
+Please describe the steps to reproduce the bug. Tell us what you noticed
+happening and what you expected to happen instead.
+
+### Attachments and links
+
+Often the best way to show the problem is to record a short video,
+attach the Preset project you were working on, and provide links.
+
+Pro-tip: You can drag and drop images and `.zip` files directly to the edit
+box when writing your bug reports. Videos are too big as attachments, you
+will have to use an external service for this and provide us links. Please
+don't use services that delete files after short periods of time.
+
+### Other important information
+
+* How often does this bug happen? (every time, often, "it only happened once")
+
+* Does this bug happen in previous firmware versions?
+
+* Does this bug happen in every project?

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project.
+title: ""
+labels: enhancement
+assignees: ""
+---
+## Hi, we're excited to hear your idea!
+
+Before you start, did you check whether your feature was already requested?
+Searching might save you quite a bit of time here.
+
+### A new feature
+
+Please tell us about your feature in as much detail as you can provide.
+Vague ideas are less likely to be successful.  Concrete requests are
+easier to estimate.

HOWTO_BETA_FIRMWARE.md

@@ -0,0 +1,57 @@
+# Testing Pre-release Builds of the Preset firmware
+
+## Before you begin
+
+Hi there! Are you interested in testing beta versions of the next
+Preset firmware?  Great, we're glad to hear that.  Let's just set
+some expectations up-front: **beta releases are provided on an "as is"
+basis**.  That means any of the following:
+
+* they may introduce new bugs that may lead to loss of work or crashes
+  during performance;
+
+* they may introduce new features that will probably not be documented
+  before the next stable release;
+
+* they may change or remove previously existing features, both
+  documented and undocumented; and
+
+* they may change the data format of the projects or instruments you
+  save, making it impossible to open them with an older firmware
+  version.
+
+If you find those risks acceptable, let's get you started!
+
+## Download a .hex file
+
+You can find the latest `.hex`` files in the
+[Releases](https://github.com/polyend/PresetIssues/releases/) section
+of this repository.  Note that the "Source Code" in each release doesn't
+actually contain Preset's sources but just this repository's files,
+including the one you're reading now.
+
+## Download the Polyend Tool
+
+You can find it on our [Downloads](https://polyend.com/downloads/) page.
+Please unpack it in a convenient location and follow the instructions in the included `!instructions.txt` file.
+
+## How to get notified about new releases?
+
+If you sign up for GitHub and subscribe to our PresetIssues repository,
+you'll get notified about new releases:
+
+![Watch releases on GitHub](./images/watch-releases-on-gh.png)
+
+## If you find bugs
+
+That's why we're testing! Report them
+[here](https://github.com/polyend/PresetIssues).
+
+
+## In case of trouble
+
+But if your device lost power during the upgrade or the firmware doesn't boot up for any other reason and it is not detected by the Polyend Tool you can perform the emergency flashing procedures as follows:
+
+* just simply press the hidden reset button on the inside of the
+module (in the middle of the area below the pads section) and it will turn the device into recovery mode. Use the Polyend Tool to flash it again.
+

README.md

@@ -0,0 +1,49 @@
+# Polyend Preset Issue Tracking
+
+![Polyend Preset Product Image](./images/product-image.jpg)
+
+This repository exists to enable community members to submit and track
+known issues with the [Polyend Preset](https://polyend.com/preset/).
+You can submit bug reports **as well as** feature requests here.
+
+## The rules are simple
+
+* **Check for duplicates** before submitting your bug report or idea.
+  We might get a little grumpy if you don't.  First time on GitHub?
+  No worries, the Search bar is right on the [Issues](https://github.com/polyend/PresetIssues/issues)
+  page.  Just try a few queries for what you're looking for.
+
+* **Always** refer to the particular firmware version you're currently
+  using.  This is crucial for us to determine if the problem is still
+  there or whether it's been already fixed.  To save yourself the
+  trouble,
+  [look here for the latest published firmware](https://polyend.com/downloads/).
+  Your issue might already be addressed!  If you're interested in testing
+  beta firmware, read [HOWTO_BETA_FIRMWARE.md](./HOWTO_BETA_FIRMWARE.md).
+
+* A **clear English description** makes it easier for us to understand you.
+  Please don't ignore the provided template!
+
+## Attachments
+
+Provide as many **attachments** as possible with your bug report.
+We're especially looking for:
+
+* direct links to videos where you show the bug;
+
+* pictures (you can drag them into the edit box when submitting your
+  bug report);
+
+* zipped projects from the SD card.
+
+## Ready to contribute?
+
+Did you read all that and after searching for your issue you don't see
+it mentioned anywhere?  Alright, click below to get started:
+
+[![New issue](./images/new-issue.png)](https://github.com/polyend/PresetIssues/issues/new/choose)
+
+## Thanks!
+
+Through your help and support we'll be able to make the Polyend Preset
+the best eurorack module it can be!