Skip to content

Latest commit

 

History

History
32 lines (17 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

32 lines (17 loc) · 1.75 KB

Contributing to Cboard

Interested in contributing to Cboard? Thanks! There are plenty of ways you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

What you need to know

In order to contribute you will need to have a basic understanding of React and probably Redux, you will also need to be familiar with Material-UI.

Submitting a Pull Request

Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for Cboard. Generally always have a related issue with discussions for whatever you are including.

Setting Up a Local Copy

  1. Clone the repo with git clone https://github.com/shayc/cboard.git

  2. Run npm install in the root cboard folder.

Once it is done, you can modify any file locally and run npm start, npm test or npm run build.

Translations

To help with translations and proofreading please use our translation management platform: https://crowdin.com/project/cboard

We currently support 33 languages, most of which were machine translated and require proofreading. Help us make Cboard available in your country!