Skip to content
This repository has been archived by the owner on Jan 24, 2022. It is now read-only.

Latest commit

 

History

History
17 lines (12 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

17 lines (12 loc) · 1 KB

Contributing

The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the Discord server instead of opening an issue – you will get redirected there anyway.

If you wish to contribute to the node-zhycorp codebase or documentation, feel free to fork the repository and submit a pull request. We use ESLint to enforce a consistent coding style, so having that set up in your editor of choice is a great boon to your development process.

Setup

To get ready to work on the codebase, please do the following:

  1. Fork & clone the repository, and make sure you're on the master branch
  2. Run yarn install
  3. Code your heart out
  4. Run npm test to run ESLint and ensure there is no TypeScript error
  5. Submit a pull request (make sure you follow the conventional commit format)