Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.34 KB
Raw

Contributing to Nova.js

Thanks for checking out Nova.js! We'd love for you to contribute. Whether you're a first-time open source contributor or an experienced developer, there are ways you can help make Nova.js great!

Where to contribute

Contributing code

If you want to contribute new hooks, fixing bugs or improving existing ones, go directly to the issues, create a new one or select one from the list that is not assigned. Then comment that you want to solve it. We will reply to you as soon as possible.

If the issue is assigned to you, please follow our requirements so that your pull request can be accepted.

Filling Issues

If you have a bug to report or a feature to suggest, you may do so on our issues page.

Before opening a new issue please check existing ones (including closed ones) to avoid duplicate issues.

Contribution requirements

Installing prerequisites

You'll need git, a recent version of Node.js (v18.X is recommended) and npm, yarn or pnpm (pnpm is recomended).

git clone https://github.com/novajslabs/nova.js
cd nova.js
pnpm install
pnpm dev

Acceptance requirements

If you want to provide new hooks, fixing errors or improving existing ones, you must comply with the following:

  1. For each hook you must provide the code in TypeScript and JavaScript
  2. The hook cannot have external dependencies
  3. If possible, the hook should be compatible with React version 16.8
  4. If the hook uses an external function, for example to parse a string, it must be included in the same hook file and not as a separate file
  5. Make sure not to track the files you're using to test the hook
  6. You can modify the App.tsx file to test the hook, but do not commit these changes to avoid conflicts

Code of Conduct

In order to keep the conversation clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.