Skip to content

Latest commit

 

History

History
103 lines (60 loc) · 3.45 KB

DEVELOPMENT.md

File metadata and controls

103 lines (60 loc) · 3.45 KB
Raw

Development Information

Source code is in the src/ subdirectory.

Development environments

Nothing is fully supported yet, but this is the goal. The directories below have scripts to enable development in various contexts:

  • src/dev/project -- for developing SMC from any project right on SageMathCloud! This is how we do most SMC dev work and is the best supported.

  • src/dev/single -- for developing SMC on a single computer, e.g., a VM. Must have sudo, and install things system-wide. Each project is a different Linux account.

  • src/dev/docker -- for running SMC in Docker. Not really intended for development use...

  • src/dev/laptop -- for development on your personal laptop (or desktop) that is not public; zero concern about security. No sudo setup. Works on Linux and OS X. Currently deprecated/not updated.

  • src/dev/smc -- related to the actual live SMC deployment, which runs on many nodes, and uses haproxy and nginx. (Will be deprecated)

Issue Triage

For the most part, we mimic Rust's triage system.

Contributors with sufficient permissions on the SMC repo can help by adding labels to triage issues:

  • Yellow, A-prefixed labels state which area of SMC the issue relates to.

  • Green, E-prefixed labels explain the type of experience necessary to fix the issue.

  • Red, I-prefixed labels indicate the importance (relevance) of the issue. The I-nominated label indicates that an issue has been nominated for prioritizing at the next triage meeting.

  • Orange, P-prefixed labels indicate a bug's priority. These labels are only assigned during triage meetings, and replace the I-nominated label.

  • The purple meta label denotes a list of issues collected from other categories.

  • The black, blocked label denotes an issue blocked by another.

If you're looking for somewhere to start, check out the E-easy tag.

The Components of SMC

Node.js modules

  • smc-util: utility code used in the browser and servers
  • smc-util-node: utility code used in servers
  • smc-hub: backend web and compute server code
  • smc-project: server code that runs in user projects
  • smc-webapp: frontend client code that runs in browser

Python modules

  • smc_pyutil: scripts and code used on servers
  • smc_sagews: Sage server

Testing

Run whole test suite:

npm test

min is the minimal reporter and other reporters are dot, progress, nyan or json - for more see here

NOTE: There is not enough testing or coverage of smc-webapp yet.

NOTE: You must already be running the PostgreSQL database, setup so that psql connects to it without having to type a password, before you an run the smc-hub test suite. See the dev/*/ directory for relevant scripts.

Upgrades

In a node.js module, type

ncu

to see all packages that are out of date not respecting semver. See https://www.npmjs.com/package/npm-check-updates for more about how to use ncu.

Lint

npm run lint

Coverage

npm run coverage

This generates a text and html summary in the coverage/ sub-directory for the given modules.

NOTE: There is no working testing or coverage of smc-webapp yet.

Start webpack watcher in development mode

./w