@scottlogic/tech-carbon-estimator - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "@scottlogic/tech-carbon-estimator",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "keywords": [
@@ -31,2 +31,7 @@ "sustainability",
   },
+  "overrides": {
+    "braces": "^3.0.3",
+    "ip": "^2.0.1",
+    "ws": "^8.17.1"
+  },
   "repository": {
@@ -33,0 +38,0 @@ "type": "git",

README.md

@@ -5,2 +5,12 @@ # sl-tech-carbon-estimator
 
+## Cloning the project
+
+When cloning the project on a Windows machine, it is recommended to add the following option:
+
+```
+git clone REPOSITORY_URL --config core.autocrlf=input
+```
+
+For more information on why this is necessary, see the section on [Line Endings](#line-endings)
+
 ## Using component
@@ -46,6 +56,10 @@
 
-## GitHub Actions
+## Pull Requests / GitHub Actions
 
-The project uses [GitHub Actions](https://docs.github.com/en/actions) to automate certain workflows. One such workflow runs when opening a pull request and pushing changes to the related branch. If you would like to skip running the workflow for a given push to a PR branch there are [various ways](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs) this can be achieved. For example, adding `[skip ci]` to the end of the commit message in the push (e.g. `git commit -m "My message [skip ci]"`) will skip running the workflow for that push.
+The project uses [GitHub Actions](https://docs.github.com/en/actions) to automate certain workflows. One such workflow runs when opening a pull request and pushing changes to the related branch. The main branch also has a branch protection rule that ensures that the status checks from this workflow have passed successfully before PRs can be merged into it.
 
+If you would like to skip running the workflow for a given push to a PR branch there are [various ways](https://docs.github.com/en/actions/managing-workflow-runs/skipping-workflow-runs) this can be achieved. For example, adding `[skip ci]` to the end of the commit message in the push (e.g. `git commit -m "My message [skip ci]"`) will skip running the workflow for that push. However, you should be aware that this will also mark the status checks in the PR as pending, which will still block it from being merged.
+
+Unfortunately Github does not recognise manually triggered runs of this workflow, so if you end up in this state you will either need to push additional changes without `[skip ci]` or amend the original commit to remove it from the description (e.g. `git commit --amend -m "My message"`), and then force push the branch (`git push --force-with-lease` - not recommended if anyone else has pulled down the branch), if there are no more legitimate changes to make.
+
 ## Further help
@@ -57,3 +71,3 @@
 
-This project is configured to use Linux/macOS line endings (Line Feed or LF), which will be enforced by prettier. If working on Windows, your editor should be configured to insert these kind of line endings (the default for VSCode using the repo settings). To prevent git from attempting to change line endings when pulling down changes you should set the following config option:
+This project is configured to use Linux/macOS line endings (Line Feed or LF), which will be enforced by Prettier. If working on Windows, your editor should be configured to insert these kind of line endings (the default for VSCode using the repo settings). To prevent git from attempting to change line endings when pulling down changes you should set the following config option:
 
@@ -70,3 +84,3 @@ ```
 
-Applying the setting when cloning rather than after cloning may help resolve issues related to line endings when setting up the project in VSCode.
+Applying the setting when cloning rather than after cloning may help resolve issues related to line endings when setting up the project in VSCode. Otherwise the default behaviour of git is to convert the line endings to the Windows standard of CRLF as you pull down the code and convert them back again on push. As Prettier can only use one standard, this then results in every line ending in the project being marked as an error within VSCode.
 
@@ -73,0 +87,0 @@ ## Documentation

No alert changes

Improved metrics

Total package byte prevSize

967241

increased by0.29%

Lines of code

4100

increased by0.34%

Number of lines in readme file

90

increased by18.42%

No dependency changes