dataware/datawareauthic
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a 'Package Managers' section to the coding guidelines

Browse source
This commit is contained in:
Jon Koops 2021-07-13 15:59:32 +02:00
parent d5b75adf74
commit 7e130e5e98
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CODING_GUIDELINES.md
View file

@ -1,5 +1,15 @@
# Coding Guidelines
## Package managers
The default package manager for the Keycloak UI projects is NPM. There are several reasons why NPM is used over other package managers (such as Yarn and PNPM):
- It comes included with NodeJS by default, meaning it does not have to be installed manually.
- Most contributors are familiar with the NPM ecosystem and tooling.
- We do not use any of the 'advanced' features of other package managers (such as [Yarn's PNP](https://yarnpkg.com/features/pnp)).
If you submit a pull request that changes the dependencies, make sure that you also update the `package-lock.json` as well.
## Typescript