Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

67 lines (49 loc) · 2.06 KB
Raw

Contributing

This repository includes a GitHub Action that builds the colorschemes once a week. This keeps the colorschemes up-to-date automatically.

Building

Dependencies

Usage for template editing

  1. Clone base16-builder-go somewhere on your system.
  2. Run cd /path/to/base-builder-go && go build to generate a binary: /path/to/base-builder-go/base16-builder-go
  3. Now execute the binary you generated while giving the -template-dir arg the path to base16-jetbrains repository: ./base16-builder-go -template-dir ../base16-jetbrains

Or the above steps represented in shell commands:

cd /path/to/base16-jetbrains/../ # This repos parent dir 
git clone git@github.com:tinted-theming/base16-builder-go.git
cd base16-builder-go
go build ./base16-builder-go/base16-builder-go \
  -template-dir ../base16-jetbrains

Usage for adding or editing a colorscheme

If you want to add or edit a colorscheme but want to test it out, you simply need to pass in your local base16-schemes directory when executing the base16-builder-go binary.

base16-builder-go \
  -schemes-dir /path/to/base16-schemes \
  -template-dir /path/to/base16-jetbrains

If you have more questions about base16-builder-go, have a look at the information on the GitHub page.

Submitting a PR

  • Run the colorscheme generation using base16-builder-go and commit the changes in your PR. Don't make changes directly to the generated colorschemes, make changes to the template instead.
  • Please abide by what's requested in the PR template.

Submitting an issue

Please follow the instructions in the issue templates: