Browse Source

Set .github items

Joseph Lenox 4 years ago
parent
commit
d61be708de

+ 3 - 0
.github/CODEOWNERS

@@ -0,0 +1,3 @@
+*  @lordofhyphens @supermerill
+
+.github/CODEOWNERS @lordofhyphens

+ 48 - 7
.github/CONTRIBUTING.md

@@ -1,21 +1,62 @@
-Did you encounter an issue with using PrusaSlicer? Fear not! This guide will help you to write a good bug report in just a few, simple steps.
+# CONTRIBUTING
 
-There is a good chance that the issue, you have encountered, is already reported. Please check the [list of reported issues](https://github.com/prusa3d/PrusaSlicer/issues) before creating a new issue report. If you find an existing issue report, feel free to add further information to that report.
+## Bug Reports
 
-If possible, please include the following information when [reporting an issue](https://github.com/prusa3d/PrusaSlicer/issues/new):
-* PrusaSlicer version (See the about dialog for the version number. If running from git, please include the git commit ID from `git rev-parse HEAD` also.)
+Did you encounter an issue with using Slic3r? Fear not! This guide will help you to write a good bug report in just a few, simple steps.
+
+There is a good chance that the issue, you have encountered, is already reported. Please check the [list of reported issues](https://github.com/alexrj/Slic3r/issues) before creating a new issue report. If you find an existing issue report, feel free to add further information to that report.
+
+If you are reporting an issue relating to a release version of Slic3r, it would help a lot if you could also confirm that the behavior is still present in the newest build [(windows)](https://bintray.com/lordofhyphens/Slic3r/slic3r_dev/). Otherwise your issue will be closed as soon as someone else isn't able to reproduce it on current master.
+
+When possible, please include the following information when [reporting an issue](https://github.com/alexrj/Slic3r/issues/new):
+* Slic3r version (See the about dialog for the version number. If running from git, please include the git commit ID from `git rev-parse HEAD` also.)
 * Operating system type + version
 * Steps to reproduce the issue, including:
     * Command line parameters used, if any
-    * PrusaSlicer configuration file (Use ``Export Config...`` from the ``File`` menu - please don't export a bundle)
+    * Slic3r configuration file (Use ``Export Config...`` from the ``File`` menu - please don't export a bundle)
     * Expected result
     * Actual result
     * Any error messages
 * If the issue is related to G-code generation, please include the following:
     * STL, OBJ or AMF input file (please make sure the input file is not broken, e.g. non-manifold, before reporting a bug)
-    * a screenshot of the G-code layer with the issue (e.g. using [Pronterface](https://github.com/kliment/Printrun))
+    * a screenshot of the G-code layer with the issue (e.g. using [Pronterface](https://github.com/kliment/Printrun) or preferably the internal preview tab in Slic3r).
+* If the issue is a request for a new feature, be ready to explain why you think it's needed.
+    * Doing more preparatory work on your end makes it more likely it'll get done. This includes the "how" it can be done in addition to the "what". 
+    * Define the "What" as strictly as you can. Consider what might happen with different infills than simple rectilinear.
 
 Please make sure only to include one issue per report. If you encounter multiple, unrelated issues, please report them as such.
 
-Simon Tatham has written an excellent on article on [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) which is well worth reading, although it is not specific to PrusaSlicer.
+Simon Tatham has written an excellent on article on [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) which is well worth reading, although it is not specific to Slic3r.
+
+## Submitting a Patch
+
+Do you want to help fix issues in or add features to Slic3r? That's also very, very welcome :)
+
+Basically you can follow the [GitHub
+flow](https://guides.github.com/introduction/flow/) for submitting
+patches, but please also read below for more specific information about
+contributing to the Slic3r project.
+
+* Development
+	* [Low Effort tasks](https://github.com/slic3r/Slic3r/labels/Low%20Effort): pick one of them!
+	* [Help Wanted tasks](https://github.com/slic3r/Slic3r/labels/help%20wanted): pick one of them!
+	* [More available tasks](https://github.com/slic3r/Slic3r/milestone/32): let's discuss together before you start working on them
+	* Please comment in the related GitHub issue that you are working on it so that other people know.
+* Review the [TODO wiki page](https://github.com/slic3r/Slic3r/wiki/TODO).
+* Contribute to the [Manual](http://manual.slic3r.org/)! (see its [GitHub repository](https://github.com/slic3r/Slic3r-Manual))
+* Add an [issue](https://github.com/slic3r/Slic3r/issues) to the GitHub tracker if it isn't already present.
+* Update Slic3r's test suite to improve test coverage [Writing Test Cases](https://github.com/slic3r/Slic3r/wiki/Code:-Writing-Test-Cases)
+* A good place to start if you can is to look over the [Pull Request or Bust](https://github.com/alexrj/Slic3r/milestones/Pull%20Request%20or%20Bust) milestone. This contains all of the things (mostly new feature requests) that there isn't time or resources to address at this time. 
+     * Things that are probably fixable via scripts (usually marked as such) have the lowest bar to getting something that works, as you don't need to recompile Slic3r to test.
+* If you're starting on an issue, please say something in the related issues thread so that someone else doesn't start working on it too.
+* If there's nothing in the [Pull Request or Bust](https://github.com/alexrj/Slic3r/milestones/Pull%20Request%20or%20Bust) milestone that interests you, the next place to look is for issues that don't have a milestone. Lots of people commit ideas to Slic3r, and it's difficult to keep up and sort through them.
+* Before sending a pull request, please make sure that the changes you are submitting are contained in their own git branch, as PRs merge histories.
+     * Pull requests that contain unrelated changes will be rejected.
+     * A common workflow is to fork the master branch, create your new branch and do your work there. git-rebase and git-cherry-pick are also helpful for separating out unrelated changes.
+* If you are pushing Slic3r code changes that touch the main application, it is very much appreciated if you write some tests that check the functionality of the code. It's much easier to vet and merge in code that includes tests and doing so will likely speed things up.
+
+## Communication
 
+* #slic3r on [FreeNode](https://webchat.freenode.net): talk to _Sound_, _LoH_ or the other members of the Slic3r community.
+* Drop Alessandro a line at aar@cpan.org.
+* Drop Joseph a line at lenox.joseph@gmail.com

+ 15 - 8
.github/ISSUE_TEMPLATE.md

@@ -1,11 +1,14 @@
 ### Version
-_Version of SupserSlicer used goes here, Use `About->About SuperSlicer`_
+_Version of Slic3r used goes here_
 
-### Operating system type + version
-_What OS are you using (and version)_
+_Use `About->About Slic3r` for release versions._
+
+_Do not report Prusa3D Slic3r bugs here without confirming it is a problem on a development release of Slic3r, or your issue will be closed. *Only* use normal Slic3r version IDs._
+
+_For -dev versions, use `git describe --tag` or get the hash value for the version you downloaded or `git rev-parse HEAD`_
 
-### 3D printer brand / version + firmware version (if known)
-_What 3D printer brand / version are you printing on, is it a stock model or did you modify the printer, what firmware is running on your printer, version of the firmware #s_
+### Operating system type + version
+_What OS are you using, and state any version #s_
 
 ### Behavior
 * _Describe the problem_
@@ -13,7 +16,11 @@ _What 3D printer brand / version are you printing on, is it a stock model or did
   * _If this is a command-line slicing issue, include the options used_
 * _Expected Results_
 * _Actual Results_
-  * _Screenshots from __*SuperSlicer*__ preview are preferred_
+  * _Screenshots from __*Slic3r*__ preview are preferred_
+
+_Is this a new feature request?_
+Related guides for writing feature requests: http://meta.stackexchange.com/a/259196 http://nickohrn.com/2013/09/write-great-feature-request-bug-report/
+
 
-#### Project File (.3MF) where problem occurs
-_Upload a SuperSlicer Project File (.3MF) (`File -> Save` / `Save Project`)_
+#### STL/Config (.ZIP) where problem occurs
+_Upload a zipped copy of an STL and your config (`File -> Export Config`)_

+ 36 - 0
.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+### Do not report Prusa3D Slic3r bugs here without confirming it is a problem on a development release of Slic3r, or your issue will be closed. [Development builds of Slic3r](https://dl.slic3r.org/dev). [Prusa3D Issue Tracker](https://github.com/Prusa3D/Slic3r/issues)
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**3D Model and Slic3r Configuration Export**
+Please upload a ZIP archive containing a copy of the 3D model you are seeing this bug with and a CTRL-E export of the configuration used.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. MacOS, Linux, Windows]
+ - Version [e.g. 1.3.0]
+     - _Do not report Prusa3D Slic3r bugs here without confirming it is a problem on a development release of Slic3r, or your issue will be closed. *Only* use normal Slic3r version IDs._
+     - _For -dev versions, use `git describe --tag` or get the hash value for the version you downloaded or `git rev-parse HEAD`_
+     - _Use `About->About Slic3r` for release versions._
+
+**Additional context**
+Add any other context about the problem here.

+ 19 - 0
.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+### Do not request features for the Prusa3D fork of Slic3r here without confirming it is applicable to the mainline Slic3r, or your issue will be closed. [Development builds of Slic3r](https://dl.slic3r.org/dev). [Prusa3D Issue Tracker](https://github.com/Prusa3D/Slic3r/issues)
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

+ 32 - 0
.github/ISSUE_TEMPLATE/old-slic3r-issue-template.md

@@ -0,0 +1,32 @@
+---
+name: Old Slic3r Issue Template
+about: Use the other ones if possible.
+
+---
+
+### Version
+_Version of Slic3r used goes here_
+
+_Use `About->About Slic3r` for release versions._
+
+_Do not report Prusa3D Slic3r bugs here without confirming it is a problem on a development release of Slic3r, or your issue will be closed. *Only* use normal Slic3r version IDs._
+
+_For -dev versions, use `git describe --tag` or get the hash value for the version you downloaded or `git rev-parse HEAD`_
+
+### Operating system type + version
+_What OS are you using, and state any version #s_
+
+### Behavior
+* _Describe the problem_
+* _Steps needed to reproduce the problem_
+  * _If this is a command-line slicing issue, include the options used_
+* _Expected Results_
+* _Actual Results_
+  * _Screenshots from __*Slic3r*__ preview are preferred_
+
+_Is this a new feature request?_
+Related guides for writing feature requests: http://meta.stackexchange.com/a/259196 http://nickohrn.com/2013/09/write-great-feature-request-bug-report/
+
+
+#### STL/Config (.ZIP) where problem occurs
+_Upload a zipped copy of an STL and your config (`File -> Export Config`)_