Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 1.87 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Table of Contents

Setting Up the project locally

To install the project you need to have node and npm

  1. Fork the project, clone your fork:

    # Clone your fork
git clone https://github.com/<your-username>/core.git

# Navigate to the newly cloned directory
cd core

  2. Your environment needs to be running node version >= 18.17.0 and npm version >= 10.2.0.

  3. from the root of the project: npm to install all dependencies

    • make sure you have latest npm version

  4. from the root of the project: npm run build to build.

  5. Your local test environment need to be setted refer to .evn.example,

    • copy .evn.example to .env in root directory.
    • modify the environment meet to your own test evnironment.

Git Commit

Pleas use npm run commit

Submitting a Pull Request

Please go through existing issues and pull requests to check if somebody else is already working on it.

Also, make sure to run the tests and lint the code before you commit your changes.

npm run test