Glad to see you here! If your are reading this, you may want to contribute to Base16-builder. Awesome! To help keeping the project as nice as possible, we ask you to following this contribution guidelines. Welcome in the contributor-side of Base16-builder.
- Search if the issue exist.
- If the issue exists, then contribute by comments, or you can create one.
- Try to be as descriptive, concise and specific as possible.
- Titles must be able to stand on their own without requiring readers to click on the issue.
- Submit your issue.
- Check if there is an issue related to your feature. If there is not, create one.
- Search for an pull request that relates to your submission. You don't want to duplicate effort.
- Fork the project.
- Create a pull request.
- Write good commits. We are using commitizen.
- Submit your pull request.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub .
You MUST follow our commit message conventions even if you're making a small change! This repository uses a tool called Commitizen to generate conventional commit messages. See this document to learn more about the commit message conventions.
You can contribute in a lot of differents way. A comment, an issue, a blog post, a video, a pull request or a new tool are all a good way to contribute to Base16-Builder. If you dont have any ideas, you can browse our "issues" pages and especially the "help wanted" label.
- Follow the specification for each one.
- Avoid duplicate as possible.
- Each contribution MUST be preceded by an issue.
A Base16-builder's template is a nunjucks file. Nunjucks is a rich and powerful templating language for JavaScript made by Mozilla. You can learn more about nunjuck files on their page.
Templates are saved in ./db/templates/.
Each template MUST follows this table:
| name | type | mandatory | note |
|---|---|---|---|
| tool | string | true | MUST contain any lowercase alphanumeric character or .- |
| luminosity | enum | true | MUST be dark or light |
| delimiter | char | false | MUST be use only if palette is used. MUST be a - |
| palette | int | false | MUST be 256 if used or nothing if not relevant |
Feel free to browse the folder templates to see valid example of template.
A Base16-builder's scheme is a YAML file. YAML is a human friendly data serialization standard for all programming languages. You can learn more about YAML files on their page.
Schemes are saved in ./db/schemes/.
Each scheme MUST follows this table:
| name | type | mandatory | note |
|---|---|---|---|
| scheme | string | true | MUST contain any lowercase alphanumeric characters or .- |
| author | string | true | MUST contain a name and MAY contain an url |
| base0X | string | true | MUST be an hexadecimal color in uppercase |
You are free to add any comments in your file. YAML comments start with the delimiter # and finish at the end of the line.
Feel free to browse the folder schemes to see valid example of scheme.
- Document your changes in the
readme.md. - Document your changes in the
--helppage. - Each contribution MUST be preceded by an issue.
- Run
npm install
- Run
npm test. All tests should pass. - Write some awesome code
- Run
npm test. All tests should still pass 😉 - Run
git add -A . - Run
npm run commitand follow the prompt. Please do not usegit commitunless you want to manually emulate the commit message convention. You shouldn't have to do this.
If you want to run the cli module locally for manual testing:
- Run
npm run build
- Run
./dist/cli <arguments>e.g../dist/cli -t i3wm -s gooey -l dark
Any help to talk about base16-builder or to help user to use it is welcome. If you made something like this, share it with us. We would love to add it somewhere in the project!
All contributors are not english speaker. If you find a typo somewhere, feel free to correct it. 😉
Attribution for contributing.md template: angular-formly.