Update PULL_REQUEST_TEMPLATE.md (#16)

This commit is contained in:
Florian Heilmann 2019-11-29 13:25:17 +01:00 committed by John Jardine
parent 2c51db4bdf
commit 7bf47649d3
1 changed files with 33 additions and 23 deletions

View File

@ -1,36 +1,46 @@
<!--
Thank you for your interest into contributing to VoronUsers, it's
Thank you for your interest in contributing to the VoronUsers repository, it is
highly appreciated!
Please make sure you have ticked all points on this
checklist:
**Please make sure the submission conforms to the rules outlined below. PRs which fail
to conform to the rules below are likely to be rejected.**
-->
* [ ] Your mod, firmware config or slicer profile is in the correct
folder.
* [ ] Your files are located in a subfolder with your name.
* [ ] If submitting STL files, make sure they are not corrupt. To test
this open them in slic3r and see if it reports any mesh errors.
* [ ] If submitting STL files, make sure they are already oriented for
printing, and scaled properly.
* [ ] If submitting firmware configs or slicer profiles make sure they
don't contain sensible data (e.g. API keys)
* [ ] Your mod, config or profile includes a short Readme.md inside its
folder summarizing what the mod accomplishes or what the config/profile
includes.
* [ ] Your PR modifies the top-level Readme.md to list your mod among the
existing ones. Read the top part of the file for instructions how to add
your mod to the table.
* [ ] If you're submitting mods you have tested them, please remember to
indicate which Voron printer this mod is intended for by updating the
compatibility matrixc in the top level Readme.md
* [ ] The mod, firmware configuration or slicer profile is in the correct category
folder. Printable mods go to `printer_mods/`, firmware configurations
go to `firmware_configurations/`, slicer profiles go to `slicer_profiles/`.
Create a subfolder with your name, and place the mods in a subfolder with
a descriptive name within that folder, e.g.: `/printer_mods/FHeilmann/flux_capacitor`
* [ ] Folders names MUST NOT contain spaces. If possible, make sure file names also
do not contain any spaces.
* [ ] For each mod, add a small `README.md` file to its folder with a short description
of what the mod accomplishes. This readme can be used to add pictures, give assembly
instructions or specify a bill of materials if the mod requires additional hardware.
* [ ] The PR modifies the top-level `README.md` of the category folder adding the
contribution to the table. Read the top part of the file for instructions on how
to do this. Please preserve the alphabetical ordering while adding new rows. Make sure
to fill out the compatibility matrix to indicate which versions of the Voron printer
the submission is compatible with.
* [ ] The mod/configuration/profile has been tested by the person submitting the mod
and/or other Voron users. Make sure to add information about how the mod was tested below.
* [ ] The mod is not merely a slight modification of an official Voron part, configuration
or profile (i.e. an official Voron part with a few mm added or removed or a slicer profile
which only modifies a few values). *(When in doubt, contact one of the admins in the
Voron discord before submitting the PR)*
* [ ] Submitted STLs are printable without support. *(If the mod does not meet this criterion
join the Voron discord and ask the other users for advice on how to modify the mod such
that it does not require supports)*
* [ ] Submitted STL files are not corrupt. *(This can be tested by opening the STL in PrusaSlicer
and checking if mesh errors are reported.)*
* [ ] Submitted STL files are oriented and scaled properly for printing.
* [ ] Submitted firmware configs or slicer profiles contain no sensitive data (e.g. API keys).
<!--
Describe your PR further using the template provided below. The more
Describe the submission further using the template provided below. The more
details the better!
-->
#### What does this PR do?
#### Which mods/configurations/profiles are added by this PR?
#### How was it tested?