Thank you for contributing on hyper-material-box, before you submit a new pull request,
here's some tips and tricks you need to know 😎
If you have any problem, feel free to submit a new issue.
- Fork this repository
- Create a new branch with the new feature name (Ex. add-some-color-scheme or fix-#000)
- Make your changes
- Commit your changes (use gitmoji)
- Push your commits
- Submit you pull request, and drink some 🍵
If you want to share your Amazing color scheme on hyper-material-box, you need to make sure you've done the following steps:
- Create a new file name
your-scheme-name.js
under scheme folder - Write your color scheme with the following format:
'use strict';
module.exports = {
colors: {
black: '...',
red: '...',
green: '...',
yellow: '...',
blue: '...',
magenta: '...',
cyan: '...',
white: '...',
lightBlack: '...',
lightRed: '...',
lightGreen: '...',
lightYellow: '...',
lightBlue: '...',
lightMagenta: '...',
lightCyan: '...',
lightWhite: '...',
},
// Default
backgroundColor: '...',
foregroundColor: '...',
cursorColor: '...',
borderColor: '...',
// Accent color
accentColor: '...',
// Other (optional, it will be override by foregroundColor)
tabTitleColor: '...',
selectedTabTitleColor: '...',
// css (optional)
css: '...',
termCSS: '...',
};
- Add your color scheme to the 👉 schemeIndex (ALPHABETICAL order)
- Add your color scheme to the 👉 README.md list (ALPHABETICAL order), and update the color scheme count
- Add your GitHub username to the 👉 Credit section with this format: (ALPHABETICAL ordered by
your-scheme-name
, and don't forget to add 2 space at the end)
:zap: The `your-scheme-name` color scheme contributed by [**@yourGitHubUserName**](https://github.com/yourGitHubUserName)
- Add your color scheme to the 👉 keywords (ALPHABETICAL order)
- Submit a pull-request
Cheers 🍻