First and foremost, thank you! We appreciate that you want to contribute to icon-shelf, your time is valuable, and your contributions mean a lot to us.
Do not create issues about bumping dependencies unless a bug has been identified, and you can demonstrate that it effects this library.
Help us to help you
Remember that we’re here to help, but not to make guesses about what you need help with:
- Whatever bug or issue you're experiencing, assume that it will not be as obvious to the maintainers as it is to you.
- Spell it out completely. Keep in mind that maintainers need to think about all potential use cases of a library. It's important that you explain how you're using a library so that maintainers can make that connection and solve the issue.
It can't be understated how frustrating and draining it can be to maintainers to have to ask clarifying questions on the most basic things, before it's even possible to start debugging. Please try to make the best use of everyone's time involved, including yourself, by providing this information up front.
Note that this repository is compatible with GitHub Codespaces as well as VS Code Remote Containers. Opening your cloned project with either of these options will perform these dev setup steps for you automatically! demo
The package manager used to install and link dependencies must be npm v7 or later.
Make sure you have Node version 16.x installed!
- Create a
forkof the main repository into your own Github account - Clone your forked repository
cdinto the directory of the repository (eg.cd icon-shelf)- Run
npm installto install dependencies for the project npm run watchstart electron app in watch mode.npm run compilebuild app but for local debugging only.npm run lintlint your code.npm run typecheckRun typescript check.npm run testRun app test.