Contributing to Open Color

Hi! We could use your help. Let us help you help us. Or something.

General

If you are looking for a place to begin, please send PRs for bugfixes instead of new features.
Help with documentation is always appreciated.
Please be courteous and constructive when commenting on issues, commits, and pull requests.

When reporting a bug, please provide steps to reproduce. If possible, show code.
If you report a bug, and it is inactive for a significant amount of time, it may be closed. Please respond promptly to requests for more information.

Before sending a large PR, it's recommended to create an issue to propose the change. Nobody wants to write a book of code and throw it away.
Due to the above, before creating a PR for a new feature, create an issue to propose the feature.
Please respect existing coding conventions, whatever those may be.
If your PR has been waiting in limbo for some time, it's very helpful to rebase against master, which will make it easier to merge.
Always run npm run compile-templates before sending a PR.

Please squash your commits when sending a pull request. If you are unfamiliar with this process, see this guide. If you have already pushed your changesets and are squashing thereafter, this may necessitate the use of a "force push". Please read the docs before you attempt this.

To add support for an additional language, create a handlebars template in the /templates directory.
The template naming scheme should follow open-color.ext.hbs where ext is the file extension of the new language (Example: a svg templates should use open-color.svg.hbs).
Register your new template in the compile-templates file by adding a call to the templatedBuilder.build function:

templatedBuilder.build('open-color.ext',
    [path.join(__dirname, 'open-color.ext')]);

Note if you want to add support for a new binary file format, please orient yourself at the usage of our .ase builder.

Be kind, be diligent, look before you leap into a PR, and follow common community conventions.

- The Open Color Team

this contributing guide is heavily inspired by mocha