Please adhere to the following guidelines when contributing to screenmycode.
- Prerequisites
- Dependencies
- Setting up the application environment and run tests
- Git commit messaging conventions
- Coding conventions and styleguides
- Filing an issue
- Adding a pull request
Required in order to run the application:
The minimum recommended version for node.js is 10.0.0, and for npm 5.6.0.
Before setting up the project, please note the following project dependencies.
The server side of the application runs on Express.js, and the client side runs on Vue.js.
Both the server side and the client side developer environment uses Typescript. The server side is using a typescript based framweork that runs ontop of express.js called TS.ed. The client side uses SASS for client side styling.
To setup the project, please follow the instructions in the respective README file for the server and the client.
Please adhere to the Conventional Commits Guide for Git commit messages.
For branch naming convention please follow this guide.
Please adhere to the setup configuration in the respective server and client tsconfig.json.
As well as the respective linting rules in the server and client tslint.json.
Also follow the respective server and client .prettierrc settings for syntax related concerns.
Issues must follow the Issue Template.
Pull requests must follow the Pull Request Template.