Skip to content

How to Contribute

Evan Ugarte edited this page Jan 17, 2022 · 3 revisions

Want to help out? Hooray πŸŽ‰!! Here is a quick guide on what to know and how to development workflow πŸ‘©β€πŸ’» πŸ‘¨β€πŸ’».

Prerequisites 🧰

At the minimum, you should know...

  • How to declare a variable in python
  • How to declare a function in python
  • How the subprocess library works in python. If you don't follow along here
  • How the argparse library works in python. If you don't follow along here

Contributing on Windows πŸͺŸ

In the How does this tool work on Windows? section of the wiki (link). We explained that the tool compiles itself into a binary to be accessible in the command line. This means that to reflect any changes you make, you need to recompile it every time. This can slow down development, so its better to run the tool while you are working on it with:

py sce.py <args>

Contributing on Unix (Mac and Linux) 🍎 🐧

Because the tool is stored as an alias, any changes you make will be instantly reflected with the sce command. Therefore running the tool while developing can be done the usual way:\

sce <args>