Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.72 KB

Contributing

Thank you for your interest! Contributions are very welcome.

Getting Started

This project uses

  • Yarn as package manager
  • ESLint and Prettier to check for and automatically fix code style issues
  • Husky and lint-staged to create a pre-commit hook which automatically fixes code style issues in changed files on commit

Before doing anything else, clone (or fork and clone) this repository, cd into it and run yarn to install all dependencies.

After installing all dependencies, it's time to get to work. The following commands can be useful (run with yarn <command>):

  • lint: lint the code using ESLint and Prettier
  • fix: auto-fix code style issues using ESLint and Prettier

To install the plugin locally for development, run ipm link --dev. Make sure "Development Mode" is turned on inside Inkdrop (Preferences > General). You'll need to reload Inkdrop (Developer > Reload) every time you make a change in the plugin. Alternatively you can install the Auto Reload plugin to automatically reload Inkdrop whenever a plugin is added/deleted/modified.

Maintainer Tasks

Some tasks only have to be performed by the maintainer:

  • To update dependencies, run yarn upgrade-interactive --latest and select the dependencies to update.
  • To release a new version, run ipm publish. Run ipm help publish to see all the supported arguments and options. After releasing the new version, go to the repository's releases on GitHub, create a new release, link it to the newly created tag and write some information about the update.