Skip to content

Commit a827b57

Browse files
andy5995lordofhyphens
authored andcommitted
consolidate contributing information
This is to help with slic3r/website#3 [skip ci]
1 parent 70946af commit a827b57

File tree

2 files changed

+26
-13
lines changed

2 files changed

+26
-13
lines changed

.github/CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# CONTRIBUTING
2+
3+
## Bug Reports
4+
15
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.
26

37
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.
@@ -24,8 +28,27 @@ Please make sure only to include one issue per report. If you encounter multiple
2428

2529
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.
2630

31+
## Submitting a Patch
32+
2733
Do you want to help fix issues in or add features to Slic3r? That's also very, very welcome :)
2834

35+
Basically you can follow the [GitHub
36+
flow](https://guides.github.com/introduction/flow/) for submitting
37+
patches, but please also read below for more specific information about
38+
contributing to the Slic3r project.
39+
40+
* Development
41+
* [Low Effort tasks](https://github.com/slic3r/Slic3r/labels/Low%20Effort): pick one of them!
42+
* [Help Wanted tasks](https://github.com/slic3r/Slic3r/labels/help%20wanted): pick one of them!
43+
* [More available tasks](https://github.com/slic3r/Slic3r/milestone/32): let's discuss together before you start working on them
44+
* Please comment in the related GitHub issue that you are working on it so that other people know.
45+
* Contribute to the [Manual](http://manual.slic3r.org/)! (see its [GitHub repository](https://github.com/slic3r/Slic3r-Manual))
46+
* You can also find us in #slic3r on [FreeNode](https://webchat.freenode.net): talk to _Sound_, _LoH_ or the other members of the Slic3r community.
47+
* Add an [issue](https://github.com/slic3r/Slic3r/issues) to the GitHub tracker if it isn't already present.
48+
* Update Slic3r's test suite to improve test coverage [Writing Test Cases](https://github.com/slic3r/Slic3r/wiki/Code:-Writing-Test-Cases)
49+
* Drop Alessandro a line at [email protected].
50+
* Drop Joseph a line at [email protected]
51+
2952
* 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.
3053
* 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.
3154
* 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.

README.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,9 @@ If you want to compile the source yourself follow the instructions on one of the
5353

5454
### Can I help?
5555

56-
Sure! You can do the following to find things that are available to help with:
57-
58-
* Development
59-
* [Low Effort tasks](https://github.com/slic3r/Slic3r/labels/Low%20Effort): pick one of them!
60-
* [Help Wanted tasks](https://github.com/slic3r/Slic3r/labels/help%20wanted): pick one of them!
61-
* [More available tasks](https://github.com/slic3r/Slic3r/milestone/32): let's discuss together before you start working on them
62-
* Please comment in the related GitHub issue that you are working on it so that other people know.
63-
* Contribute to the [Manual](http://manual.slic3r.org/)! (see its [GitHub repository](https://github.com/slic3r/Slic3r-Manual))
64-
* You can also find us in #slic3r on [FreeNode](https://webchat.freenode.net): talk to _Sound_, _LoH_ or the other members of the Slic3r community.
65-
* Add an [issue](https://github.com/slic3r/Slic3r/issues) to the GitHub tracker if it isn't already present.
66-
* Update Slic3r's test suite to improve test coverage [Writing Test Cases](https://github.com/slic3r/Slic3r/wiki/Code:-Writing-Test-Cases)
67-
* Drop Alessandro a line at [email protected].
68-
* Drop Joseph a line at [email protected]
56+
Sure, but please read the
57+
[CONTRIBUTING](https://github.com/slic3r/Slic3r/blob/master/.github/CONTRIBUTING.md)
58+
document first!
6959

7060
### Directory structure
7161

0 commit comments

Comments
 (0)