Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

24 lines (15 loc) · 1.68 KB

Contributing

If you have discovered a bug or have a feature suggestion, feel free to create an issue on GitHub.

If you'd like to make some changes yourself, see the following:

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Make sure yarn is globally installed (npm install -g yarn)
  3. Run yarn to download required packages.
  4. Build and start the application: yarn dev
  5. If you contributed something new, run yarn contrib:add <your GitHub username> <contribution type> to add yourself to the contributors list
  6. Finally, submit a pull request with your changes!

This project follows the all-contributors specification. Contributions of any kind are welcome!

Automated Setup

Alternatively, you can also open this repository in Gitpod, an online IDE for GitHub. Just click on the button below and all of the above mentioned work is automated, so you don't have to worry about setting up your environment.

Open in Gitpod

Adding themes/languages

We are not currently accepting new themes or languages into Carbon, except for in extenuating circumstances. Instead, we want to continue to provide ways for users to add their own themes and presets. Please feel free to still open an issue or PR for consideration, but know that there is a chance it will get closed without addition.