Skip to content

Commit 2d679a1

Browse files
committed
Update ISSUE_TEMPLATE.md and fix links in CONTRIBUTING.md
1 parent c75490d commit 2d679a1

File tree

2 files changed

+38
-13
lines changed

2 files changed

+38
-13
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
The following is a set of guidelines for contributing to LibSass, which is hosted in the [Sass Organization](https://github.com/sass) on GitHub.
66
These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
77

8-
LibSass is a library that implements a [sass language] [8] compiler. As such it does not directly interface with end users (frontend developers).
8+
LibSass is a library that implements a [sass language][8] compiler. As such it does not directly interface with end users (frontend developers).
99
For direct contributions to the LibSass code base you will need to have at least a rough idea of C++, we will not lie about that.
1010
But there are other ways to contribute to the progress of LibSass. All contributions are done via github pull requests.
1111

12-
You can also contribute to the LibSass [documentation] [9] or provide additional [spec tests] [10] (and we will gladly point you in the
12+
You can also contribute to the LibSass [documentation][9] or provide additional [spec tests][10] (and we will gladly point you in the
1313
direction for corners that lack test coverage). Foremost we rely on good and concise bug reports for issues the spec tests do not yet catch.
1414

1515
## Precheck: My Sass isn't compiling
16-
- [ ] Check if you can reproduce the issue via [SourceMap Inspector] [5] (updated regularly).
17-
- [ ] Validate official ruby sass compiler via [SassMeister] [6] produces your expected result.
18-
- [ ] Search for similar issue in [LibSass] [1] and [node-sass] [2] (include closed tickets)
19-
- [ ] Optionally test your code directly with [sass] [7] or [sassc] [3] ([installer] [4])
16+
- [ ] Check if you can reproduce the issue via [SourceMap Inspector][5] (updated regularly).
17+
- [ ] Validate official ruby sass compiler via [SassMeister][6] produces your expected result.
18+
- [ ] Search for similar issue in [LibSass][1] and [node-sass][2] (include closed tickets)
19+
- [ ] Optionally test your code directly with [sass][7] or [sassc][3] ([installer][4])
2020

2121
## Precheck: My build/install fails
2222
- [ ] Problems with building or installing libsass should be directed to implementors first!
@@ -47,7 +47,7 @@ direction for corners that lack test coverage). Foremost we rely on good and con
4747
## What makes a code test case
4848

4949
Important is that someone else can get the test case up and running to reproduce it locally. For this
50-
we urge you to verify that your sample yields the expected result by testing it via [SassMeister] [6]
50+
we urge you to verify that your sample yields the expected result by testing it via [SassMeister][6]
5151
or directly via ruby sass or node-sass (or any other libsass implementor) before submitting your bug
5252
report. Once you verified all of the above, you may use the template below to file your bug report.
5353

.github/ISSUE_TEMPLATE.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,54 @@
1-
### Title: Be as meaningful as possible in 60 chars if possible
1+
[todo]: # (Title: Be as meaningful as possible)
2+
[todo]: # (Title: Try to use 60 or less chars)
3+
4+
[todo]: # (This is only a template!)
5+
[todo]: # (remove unneeded bits)
6+
[todo]: # (use github preview!)
7+
8+
## input.scss
9+
10+
[todo]: # (always test and report with scss syntax)
11+
[todo]: # (use sass only when results differ from scss)
212

3-
input.scss
413
```scss
514
test {
615
content: bar
716
}
817
```
918

10-
[libsass 3.5.5] [1]
19+
## Actual results
20+
21+
[todo]: # (update version info!)
22+
23+
[libsass 3.X.y][1]
1124
```css
1225
test {
1326
content: bar; }
1427
```
1528

16-
ruby sass 3.4.21
29+
## Expected result
30+
31+
[todo]: # (update version info!)
32+
33+
ruby sass 3.X.y
1734
```css
1835
test {
1936
content: bar; }
2037
```
2138

39+
[todo]: # (update version info!)
40+
[todo]: # (example for node-sass!)
41+
2242
version info:
2343
```cmd
2444
$ node-sass --version
25-
node-sass 3.3.3 (Wrapper) [JavaScript]
26-
libsass 3.2.5 (Sass Compiler) [C/C++]
45+
node-sass 3.X.y (Wrapper) [JavaScript]
46+
libsass 3.X.y (Sass Compiler) [C/C++]
2747
```
2848

49+
[todo]: # (Go to http://libsass.ocbnet.ch/srcmap)
50+
[todo]: # (Enter your SCSS code and hit compile)
51+
[todo]: # (Click `bookmark` and replace the url)
52+
[todo]: # (link is used in actual results above)
53+
2954
[1]: http://libsass.ocbnet.ch/srcmap/#dGVzdCB7CiAgY29udGVudDogYmFyOyB9Cg==

0 commit comments

Comments
 (0)