CONTRIBUTING.md

👨💻 Helping Develop Pseudonaja

Get Started

Ready to contribute? Here’s how to set up Pseudonaja for local development.

Clone a Repo

First you must fork the repo relevant to what you plan to change. Then you must clone the repo to your local machine in order to make changes.

Changes To The Editor

$ git clone git@github.com:PutYourUsernameHere/editor.git

Changes To The Docs

$ git clone git@github.com:PutYourUsernameHere/docs.git

Create a Branch:

$ git checkout -b name-of-your-bugfix-or-feature

Now make your changes.

Testing

While there are no automated tests set up, it is highly encouraged that you thoroughly test anything your changes may have affected.

If your changes affect the codemirror files, you will need to roll up the editor files to a single file for use in the browser. The repo is already set up with a rollup configuration, so simply run:

$ npx rollup -c

Then just serve the project directory. An easy way to do this, if you have Python installed, is the following:

$ python3 -m http.server 8080

Commit and Push Changes:

Once you are sure your changes work and haven't broken anything, push them to your forked repo.

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a Pull Request to the Relevant GitHub Repo

• Editor
• Documentation