fb1865d70fd03332e9776bc85771cc1c8a37463c maximilianh Sun Sep 14 12:01:21 2025 -0700 moving to python3 for default script stubs and adding a note to contributing.md diff --git contributing.md contributing.md index 5ef58ef..151f24d 100644 --- contributing.md +++ contributing.md @@ -1,15 +1,8 @@ -# Contributing to the Cell Browser +All the javascript code is located under src/cbPyLib/cellbrowser/cbWeb/js/ +(css etc are in directories not to js) -Thanks for taking the time to contribute! +Git clone this repo and make changes to the files -You've found a bug or have an idea for a feature? -Great! You can open an issue in Github. If you don't know what that means, just email us -at cells@ucsc.edu. We are happy about any pull requests. We try to get back to you within 1-2 days, especially on obvious bugs. -Before you submit a pull request, don't hesitate to ask by email or via an issue. Maybe we are already working on it or have some opinion how to best implement something. - -## Contribution Guidelines - -* Make sure your text editor is set to remove tab characters and replaces them with spaces. -* We use K&R indentation, camelCase variable names and globals are not uppercase, but don't worry, we can fix up any PRs for you -* The main Javascript file is src/cbPyLib/cellbrowser/cbWeb/js/cellbrowser.js -* The main Python code is src/cbPyLib/cellbrowser/cellbrowser.py +Then run 'cbUpgrade --dev --code' to package all the css/js files together into the htdocs directory. +Either set this directory with -o to cbUpgrade, via the CBOUT variable or in the ~/.cellbrowser file +with the configuration statement 'htmlDir', e.g. 'htmlDir=/var/www/' or 'htmlDir=~/public_html/cells'.