You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
carbon/.github/CONTRIBUTING.md

1.9 KiB

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> to add yourself below
  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're happy to accept any PRs adding new themes and languages to Carbon! Currently there are a few ways to do so:

  1. If the theme or language is supported in Codemirror, all you have to do is add a constant for it.

  2. If it's not supported, you can add a Codemirror compliant custom theme or custom mode to implement it and add a constant like above.