aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRael Gugelmin Cunha <rael.gc@gmail.com>2015-05-01 16:35:54 -0300
committerRael Gugelmin Cunha <rael.gc@gmail.com>2015-05-01 16:35:54 -0300
commitc55c74d3da70bc416e6eca6a6a48ccec460fa750 (patch)
tree6899d7370ab695cab19f149f2507de70b1441162 /CONTRIBUTING.md
parent37d7a1832da450daf646c87181da39b520b88d71 (diff)
downloadscudcloud-c55c74d3da70bc416e6eca6a6a48ccec460fa750.zip
scudcloud-c55c74d3da70bc416e6eca6a6a48ccec460fa750.tar.gz
scudcloud-c55c74d3da70bc416e6eca6a6a48ccec460fa750.tar.bz2
Adding info about the main JS file
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4d5148f..edcbadf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,4 +18,18 @@ Contributions are welcomed and appreciated! To start contributing:
6. Make your changes
- `$ git commit -am "implement feature"`
7. Submit a pull request on GitHub.com
- - `$ git push origin named-feature-branch` \ No newline at end of file
+ - `$ git push origin named-feature-branch`
+
+In case you need to inspect HTML/CSS/Javascript, start ScudCloud enabling the web console:
+
+ scudcloud --debug=True
+
+Then right in any element, and select `Inspect Element`. Then select `Console`.
+
+## ScudCloud.js
+
+Some JavaScript functions are injected in Slack, to enable integration with ScudCloud. Then file is minimized, to allow a better performance.
+
+To see the original source file, see this Gist: https://gist.github.com/raelgc/9be7b48f4793c65232c2
+
+If you change anything, minimize with http://jscompress.com/, but remember to restore the last line (the one with `boot_data`): this line is always removed by `jscompress`, and it's really important!