2021-03-18 16:58:46 +01:00
|
|
|
# Contributing Guidelines
|
2021-02-08 19:20:37 +01:00
|
|
|
|
2021-03-17 19:35:11 +01:00
|
|
|
Pull requests from everyone are welcome
|
|
|
|
|
|
|
|
|
|
Procedure for contributing:
|
2021-03-17 19:45:15 +01:00
|
|
|
|
2021-03-17 19:35:11 +01:00
|
|
|
- Create a fork of the repository on github
|
|
|
|
|
In a top right corner of a GitHub, select "Fork"
|
2021-03-26 20:37:43 +01:00
|
|
|
Its recommended to fork latest version from main branch to avoid any possible conflicting code updates
|
2021-03-17 19:35:11 +01:00
|
|
|
- Clone your forked repository to your local system
|
|
|
|
|
`git clone https://github.com/<your-username>/<your-fork>
|
|
|
|
|
- Make your changes
|
|
|
|
|
- Test your changes against code guidelines
|
|
|
|
|
`npm run lint`
|
2021-03-26 17:37:08 +01:00
|
|
|
- Test your changes in Browser and NodeJS
|
|
|
|
|
`npm run dev` and naviate to https://localhost:10031
|
2021-04-16 14:34:16 +02:00
|
|
|
`node test/test-node.js`
|
2021-03-26 17:37:08 +01:00
|
|
|
- Push changes to your fork
|
|
|
|
|
Exclude files in `/dist', '/types', '/typedoc' from the commit as they are dynamically generated during build
|
2021-03-18 16:58:46 +01:00
|
|
|
- Submit a PR (pull request)
|
2021-03-17 19:35:11 +01:00
|
|
|
|
|
|
|
|
Your pull request will be reviewed and pending review results, merged into main branch
|
