Skip to content

Latest commit

聽

History

History
55 lines (31 loc) 路 3.12 KB

CONTRIBUTING.md

File metadata and controls

55 lines (31 loc) 路 3.12 KB
Raw

Contributing to Treejer

We welcome all forms of contributions! You can start with some good first isssues. You can also go through other existing issues or create new ones in the issues dashboard.

You can find our contributing guide on our website.

Legal Notice

All contributions must and will be licensed under GNU General Public License v3.0.

Code of Conduct

Treejer has adapted its Code of Conduct from the Contributer Covenant (v2.1). All community members are expected to adhere to it. Please refer here for more details.

Developer Setup

Preliminary Steps

  1. The preferred workflow for contributing to Treejer is to fork the main repository on GitHub and create a new branch.
  2. Clone the forked repository to your local.

Docker

In order to facilitate better development and testing, the project has been integrated with Docker and Docker Compose. This eliminates the necessity to setup the entire environment in your local machine. Simply spin up the required container and start developing or testing in it.

Requirements

  • Docker - If you don't have Docker installed in your local machine, you can get it by following the steps here. This should also install docker-compose.

Setup

Two modes can be enabled via docker:

  1. Development: This creates a container with the project and all the dependencies installed in it. The project location in your local machine will be linked as a volume to the container and any edits you make in your local would be synced to the container. To spin up the development container run: docker-compose up develop inside the project folder on your local.
  2. Testing: This brings up a container and runs all the tests in it automatically and then kills the container. This can be used purely for testing purposes. To spin up a testing container run: docker-compose up test inside the project folder on your local.

Local

If you are unable to install docker in your local, then you can setup the environment directly by following the steps mentioned below.

Requirements

  • node>=13.0.0

Setup

  1. Once inside the project folder on your local, run npm install to install all the dependencies.
  2. Start Ganache using: npm run ganache
  3. Run all the tests using npm run test
  4. Deploy to the local ganache using npm run deploy

Get in touch

You can join the contributors channel our Discord.

Vulnerabilities should be disclosed directly to the Treejer team by emailing security@treejer.com.