Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (29 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.72 KB

Contributing

Issues

Please leave an issue for any enhancement requests or bug reports, making sure you're using the appropriate label.

New Themes

To contribute a new theme, please do the following:

  • Make a fork of the repository
  • Put your theme folder inside of the repository's themes folder
  • Include a README.md with your theme, using the template below
  • Submit a pull request with the title Theme Submission: <theme name>

README Template

# theme_name 

- Theme Source: *Reference to information about the theme elsewhere. Required if you're submitting a theme based on a palette you didn't create.*
- Owner(s): *Your GitHub username(s). Used to auto-approve submitted theme update PRs. This refers to the theme submission owner, NOT the palette/name/copyright/etc. owner*
- Contributor(s): *GitHub username(s) of anybody who has submitted an update, but isn't an original author (if any)*


## Preview

![Theme preview for theme_name](./example.png)

If you wish to submit a theme that can freely have suggestions submitted by others, please put - Owner: Community with yourself as a contributor

Theme Updates

Community-owned Themes

Really like one of the defaults but find that it could use another category?
Think one of the existing categories could use a few more filetypes?
Have some unreasonably strong opinions on hex colors?

Submit a PR! I'd love your help making the defaults even better for everyone!

User-owned Themes

  • Are you an existing theme author?
    • Yes: Make whatever changes you want and submit a PR! I'll almost certainly pass it through without issue.
    • No: Feel free to make suggestions and submit a PR, but you must add a theme owner as a required reviewer.