From 6856f84faa56405ec1f8257f9d34771d767a5a33 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 5 Nov 2020 17:15:53 +0000 Subject: [PATCH] Doc: Update doc --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a36ad11fb..02b8b933f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,9 +44,9 @@ Building the apps is relatively easy - please [see the build instructions](https Coding style is enforced by a pre-commit hook that runs eslint. This hook is installed whenever running `npm install` on any of the application directory. If for some reason the pre-commit hook didn't get installed, you can manually install it by running `npm install` at the root of the repository. -For new React components, please use [React Hooks](https://reactjs.org/docs/hooks-intro.html). For new code in general, please use TypeScript (unless you are modifying a file that was originally in JavaScript). +For new React components, please use [React Hooks](https://reactjs.org/docs/hooks-intro.html). For new code in general, please use TypeScript. Even if you are modifying a file that was originally in JavaScript you should ideally convert it first to TypeScript before modifying it. Doing so is relatively easy and it helps maintain code quality. -For changes made to the Desktop client that affect the user interface, refer to `packages/app-desktop/app/theme.js` for all styling information. The goal is to create a consistent user interface to allow for easy navigation of Joplin's various features and improve the overall user experience. +For changes made to the Desktop client that affect the user interface, refer to `packages/app-desktop/theme.ts` for all styling information. The goal is to create a consistent user interface to allow for easy navigation of Joplin's various features and improve the overall user experience. ## Automated tests diff --git a/README.md b/README.md index 4338c46960..f41016c732 100644 --- a/README.md +++ b/README.md @@ -404,7 +404,7 @@ Please see the [donation page](https://github.com/laurent22/joplin/blob/dev/read # Contributing -Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md +Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/dev/CONTRIBUTING.md # Localisation