Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 2.79 KB

Contributing to Boats Animator

Thank you for choosing to help improve Boats Animator!

Important This project is currently undergoing a complete rewrite to use React, TypeScript and Electron. As a result, this document is currently out of date. Check the GitHub Project to keep up on progress.

Setup

  1. Make sure Git and Node.js are installed on your computer.
  2. Fork this repository by pressing Fork at the top of this page.
  3. Clone the fork to your computer using: git clone https://github.com/YOUR_USERNAME/boats-animator.git or GitHub Desktop.
  4. Run npm install in the boats-animator directory.

Running from source code

To preview Boats Animator simply run npm start in a terminal window.

Building from source code

To build packages for Boats Animator for the current operating system run: npm run-script build.

Reporting issues

If you find a bug or want to suggest an improvement:

  • First check someone else hasn't already reported it in the issues section.
  • If not, create a new issue for it.
  • Please make sure to include a clear title and description as well as any relevant error messages, code snippets or screenshots.

Submitting changes

If you're working on an improvement to Boats Animator it is usually good practise to add a comment to the relevant issue. Once you are ready to submit your changes you should:

  • Create a new pull request with a clear list of what you've done (read more about pull requests).
  • The pull request should reference any relevant issues and have a clear title.
  • The log messages for any commits should also be clear.
  • The coding conventions for Boats Animator should be followed.
  • If your pull request brings any visible changes, the Markdown based documentation in the docs directory should be updated.

Coding conventions

The following conventions should be observed in Boats Animator's code:

  • Features with the Webkit prefix may be used if there is no standardised method available.
  • Code should use 2 space indentation.
  • Trailing white space should be avoided.
  • HTML classes and ids are spaced-using-dashes. JavaScript variables and functions are spacedUsingCamelCase.
  • JavaScript functions should be documented using JSDoc notation.