Skip to content

How to Contribute

defr0zen edited this page May 29, 2017 · 3 revisions

Contributing to Carbonium

There are many ways to contribute to Carbonium: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

After cloning and building the repo, check out the issues for a list of all potential areas for contributions.

To improve the chances to get a pull request merged you should select an issue that is labelled with the help-wanted or bug labels. If the issue you want to work on is not labelled with help-wanted or bug, you can start a conversation with the issue owner asking whether an external contribution will be considered.

Make a Design If Needed

Many tasks require changes to the design (graphical interface). To ensure that we create a consistent user experience, we must use the same design language and follow the same processes.

  • The task should have a design-needed label.
  • Explore the Carbonium UI kit and the shared project with the existing design. //TODO: add links
  • Create the pull request and add a link to your design. This could be a Carbonium project, an image, css code - it does not matter as long as it follows the same design patterns and it is clear how to implement it.
  • Wait for the Carbonium team to accept your proposed design by adding the design-accepted label.
  • If you then would like to implement html/less, read on how to build and run the project.

Build and Run From Source

Carbonium is built with ReactJS and Webpack.

Discussion Etiquette

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.

Clone this wiki locally