Skip to content

Commit 3b6171b

Browse files
committed
Moved instructions from the SASS file to "contributinng/css.rst"
1 parent 426fdb2 commit 3b6171b

3 files changed

Lines changed: 25 additions & 12 deletions

File tree

admin/css/debug-toolbar/toolbar.scss

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,6 @@
88
*/
99

1010

11-
// GUIDE TO GENERATE THE CSS FILE
12-
// ========================================================================== */
13-
14-
// 1. Open the Terminal
15-
// 2. Install SASS: https://sass-lang.com/install
16-
// 3. Go to the SASS folder: "cd system/Debug/Toolbar/Views/SASS"
17-
// 4. Generate the CSS file: "sass --no-cache --scss --sourcemap=none toolbar.scss ../toolbar.css"
18-
19-
2011
// IMPORTS
2112
// ========================================================================== */
2213

contributing/README.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Contributing to CodeIgniter
55
- `Contribution guidelines <./guidelines.rst>`_
66
- `Contribution workflow <./workflow.rst>`_
77
- `Contribution signing <./signing.rst>`_
8+
- `Contribution CSS <./css.rst>`_
89
- `Framework internals <./internals.rst>`_
910
- `CodeIgniter documentation <./documentation.rst>`_
1011
- `PHP Style Guide <./styleguide.rst>`_
@@ -54,7 +55,7 @@ If you've found a critical vulnerability, we'd be happy to credit you in our
5455
Tips for a Good Issue Report
5556
****************************
5657

57-
Use a descriptive subject line (eg parser library chokes on commas) rather than
58+
Use a descriptive subject line (eg parser library chokes on commas) rather than
5859
a vague one (eg. your code broke).
5960

6061
Address a single issue in a report.
@@ -65,13 +66,13 @@ Explain what you expected to happen, and what did happen.
6566
Include error messages and stacktrace, if any.
6667

6768
Include short code segments if they help to explain.
68-
Use a pastebin or dropbox facility to include longer segments of code or
69+
Use a pastebin or dropbox facility to include longer segments of code or
6970
screenshots - do not include them in the issue report itself.
7071
This means setting a reasonable expiry for those, until the issue is resolved or closed.
7172

7273
If you know how to fix the issue, you can do so in your own fork & branch, and submit a pull request.
7374
The issue report information above should be part of that.
7475

7576
If your issue report can describe the steps to reproduce the problem, that is great.
76-
If you can include a unit test that reproduces the problem, that is even better,
77+
If you can include a unit test that reproduces the problem, that is even better,
7778
as it gives whoever is fixing it a clearer target!

contributing/css.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
================
2+
Contribution CSS
3+
================
4+
5+
CodeIgniter uses SASS to generate the debug toolbar's CSS. Therefore, you
6+
will need to install it first. You can find further instructions on the
7+
official website: https://sass-lang.com/install
8+
9+
Compile SASS files
10+
==================
11+
12+
Open your terminal, and navigate to CodeIgniter's root folder. To generate
13+
the CSS file, use the following command: ``sass --no-cache --sourcemap=none admin/css/debug-toolbar/toolbar.scss system/Debug/Toolbar/Views/toolbar.css``
14+
15+
Details:
16+
- ``--no-cache`` is a parameter defined to disable SASS cache, this prevents
17+
a "cache" folder from being created
18+
- ``--sourcemap=none`` is a parameter which prevents soucemap files from
19+
being generated
20+
- ``admin/css/debug-toolbar/toolbar.scss`` is the SASS source
21+
- ``system/Debug/Toolbar/Views/toolbar.css`` is he CSS destination

0 commit comments

Comments
 (0)