Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 3.46 KB

To contribute

If you are working on an existing issue, please claim it with your comment, so there is no duplicate work.

What you will need before you begin:

Dev Env Setup

See package.json for all the npm run ... scripts or view/execute them in vscode explorer sidebar.

  1. Ensure NodeJS version 12.16.3 LTS or larger is installed on your system.
  2. Clone the repository using git.
  3. Run npm run i in the folder that you've just cloned to ensure you have all dependencies that are needed for development.
  4. Install the @recommended extensions if using VSCode editor.
  5. Run npm run start to start the app on https://localhost:9200
  6. Run npm run start:electron after previous step to run the web app inside electron window

Hidden Files in VSCode

Some files are hidden in vscode file viewer by default (mostly config files, not relevant to actual development), see the files.exclude option in the settings file to enable them if needed.

To quickly enable/disable the hidden files in vscode, you can use the recommended adrianwilczynski.toggle-hidden extension.

VS Code Folder/File Icons

VSCode Material Icon Theme workspace settings regarding folder and file associations do not work unless they are defined in the user settings file.

Copy/Paste material-icon-theme.folders.associations and material-icon-theme.files.associations into your user settings.json from the definitions in .vscode/settings.json.

Steps to follow when your work is ready:

When your work is done:

  1. Run npm run build.
  2. Run npm affected:test
  3. After a successful build and tests, make a commit and push your changes. If you're fixing a existing issue: be sure to link to that issue in the git commit message, like so: Closes #IssueNumberThatGetsFixed.
  4. Create a new Pull Request.
  5. Write a good description of the changes this pull-request will make.
  6. You must provide screenshots if there is a visual change.

Notes

This project has the following technologies

Read more about them here

Formatting/Code Styles

Prettier Formatter is set up along with the VSCode Prettier Extension to enforce consistent code style/formatting along with Husky and Lint Staged to auto format before commits are pushed.