CONTRIBUTING.adoc

Contributing to zigen.io

Thank you for considering contributing to zigen.io!!!

Please feel free to ask us any questions in our discord server!

Creating a pull request

To contribute to this repository with your code, you will fork this repository, push your changes to a branch in your fork, and then create a pull request from that branch to the main branch of this repository.

We will arrange help wanted issues and good first issues soon so that you can find some good issues for your first pull request.

Creating an issue

If you find a problem or want to request a new feature, please create an issue in this repository.

Building

1. Install the necessary development tools.

   • NodeJS: version 16.14.2 LTS is recommended.

   • yarn

2. Install packages

   yarn install

3. To launch a development server, run the following command.

   yarn dev

4. Open http://localhost:3000

zigen.io uses Next.js. Please see the Next.js website for details.

Linter

This project uses eslint and prettier for linting. Please check your code by

yarn lint

We recommend to use some editor plug-ins for linting if exists.