Interested in contributing to skale-engine? We'd love your help. Skale-engine is an open source project, built one contribution at a time by users just like you.
- If you have a question about using skale-engine, start a discussion on gitter or on google group
- If you think you have found a bug within skale-engine, open an issue. Do not forget to check that it doesn't already exist in our issue database
- If you have a suggestion for improvement or a new feature, create a pull request so it can be discussed and reviewed by the community and project committers. Even the project committers submit their code this way.
- Create your own fork on github, then checkout your fork
- Write your code in your local copy. It's good practice to create a branch for each new issue you work on, although not compulsory
- Your code must follow existing coding style, and tests must pass.
To check coding style, run
npm run lint. The coding style of skale is the same as in core NodeJS. To run the tests, first runnpm install, thennpm test - If the tests pass, you can commit changes to your fork and then create a pull request from there. Reference any relevant issue by including its number in the message, e.g. #123