/comments

Tooling to encourage comments in TypeScript and JavaScript codebases.

Primary LanguageJavaScriptMIT LicenseMIT


svg logo



Continuous integration badge for github actions

Add your motivational tagline here.


Getting Started

Use the following steps when first using this template.

  • Find and replace remirror/template with user/repo across the whole project.
  • Replace << TEMPLATE NAME >> in the LICENSE file with the name of your choosing.
  • Replace the template package in the packages folder with a package of your choosing.
  • OPTIONAL: For automatic publishing add your npm token to to your github repo secrets with the name NPM_TOKEN.

Contributing

Please read our contribution guide for details on our code of conduct, and the process for submitting pull requests. It also outlines the project structure so you can find help when navigating your way around the codebase.

In addition each folder in this codebase a readme describing why it exists.

You might also notice there are surprisingly few files in the root directory of this project. All the configuration files have been moved to the support/root directory and are symlinked to the root directory in a preinstall hook. For more information take a look at folder and readme.


Versioning

This project uses SemVer for versioning. For the versions available, see the tags on this repository.


License

This project is licensed under the MIT License - see the LICENSE file for details