diff --git a/DEVELOPER.md b/DEVELOPER.md index 7889c2ee..ac10ac25 100644 --- a/DEVELOPER.md +++ b/DEVELOPER.md @@ -19,18 +19,16 @@ npm install ## Creating a new package -Create a new package using the built-in schematic tool: +1. Create a new package using the built-in schematic tool: + ```sh + npm run new-package + ``` -```sh -npm run new-package -``` - -Reorder alphabetically what was generated in `README.md` and `.github/workflows/ci_release.yml`. - -If this new package has any other internal packages as peer dependencies: -- make sure that this new package is also tested during the tests of the other packages +2. Reorder alphabetically what was generated in `README.md` and `.github/workflows/ci_release.yml`. -*(have a look at [ci_test_core.yml](https://github.com/DSI-HUG/ngx-components/blob/main/.github/workflows/ci_test_core.yml#L27-L29) for examples)* +3. If this new package has any other internal packages as peer dependencies: + - Make sure that this new package is also tested during the tests of the other packages
+ *(have a look at [ci_test_core.yml](https://github.com/DSI-HUG/ngx-components/blob/main/.github/workflows/ci_test_core.yml#L27-L29) for examples)* ## Linting/verifying source code @@ -68,28 +66,28 @@ This project comes with automatic continuous delivery (CD) using *GitHub Actions To publish a package: -1. Trigger a new: [Workflow release](https://github.com/dsi-hug/ngx-components/actions/workflows/ci_release.yml) +1. Trigger a new [workflow release](https://github.com/dsi-hug/ngx-components/actions/workflows/ci_release.yml) 2. Watch the results in: [Actions](https://github.com/dsi-hug/ngx-components/actions) ### ⚠️ First release > A previous tag needs to be found to compute the next semver version. -So when you publish a package for the first time, you will have to do the following: +When you publish a package for the first time, you will have to do the following: 1. Commit and push the package, using this commit message: -```sh -feat(): first commit -``` + ```sh + feat(): first commit + ``` -2. Add a tag to the commit prior to the one you just created, and push it: -```sh -@hug/ngx-@1.0.0 -``` +3. Add a tag to the commit prior to the one you just created, and push it: + ```sh + @hug/ngx-@1.0.0 + ``` -3. Trigger a new release +4. Trigger a new release -4. Once done, remove the tag you previously created +5. Once done, remove the tag you previously created [git]: https://git-scm.com/