We welcome everyone contributing to this project, thank you for investing time in contributions. The document is to help you on setting up development environment and opening a pull request.
Make sure you have the following installed on your machine:
git clone https://github.com/eStreamSoftware/docs-sqlpay.git
cd docs-sqlpayInstall the project dependencies:
npm installnpm run startOpen http://localhost:3000 in your browser to view the project.
We recommend to use vscode in this project with the following extension installed:
- markdownlint : markdown files linter
Gitpod is a free, online, vscode alike code editor for contributing. You can launch it with a single click on the button below. What it does:
- clone the repository
- install the dependencies
- run
npm run start
You can start editing straight away.
An alternative of online web-based code editor. You can open this repository in github.dev by simply pressing . while browsing the repository.
In this repository, we practice semantic commit message. How does a semantic commit message looks like? here's an example:
<type>: <subject>
The various types of commits:
feat: new feature for the end userfix: bug fix for the end userdocs: changes to the documentation related to the repositorystyle: formatting, missing semi colons, etcrefactor: refactoring production code, eg. renaming a variabletest: adding missing tests, refactoring tests