File tree 3 files changed +18
-3
lines changed
3 files changed +18
-3
lines changed Original file line number Diff line number Diff line change
1
+ # Don't track the Node.js installation artifacts
2
+ /node_modules /
3
+ /package-lock.json
Original file line number Diff line number Diff line change @@ -56,13 +56,19 @@ npm install --save https://github.com/HatScripts/circle-flags
56
56
## Contributing
57
57
58
58
To contribute, you need to have the latest version of [ svgo] ( https://github.com/svg/svgo ) installed.
59
+ You can run the following command to install it in the circle-flags project directory:
60
+
61
+ ``` sh
62
+ npm install
63
+ ```
59
64
60
65
First, edit the relevant SVG files in the ` flags/ ` directory.
61
66
62
- Then run ` svgo ` to optimize the SVG files:
67
+ Then run the ` svgo ` wrapper script (defined in the scripts section of [ package.json] ( ./package.json ) ),
68
+ which uses the locally-installed ` svgo ` executable to optimize the SVG files:
63
69
64
70
``` sh
65
- svgo ./flags --recursive --config= svgo.config.js
71
+ npm run svgo
66
72
```
67
73
68
74
Then commit the changes, and submit them as a pull request.
Original file line number Diff line number Diff line change 33
33
"bugs" : {
34
34
"url" : " https://github.com/HatScripts/circle-flags/issues"
35
35
},
36
- "homepage" : " https://github.com/HatScripts/circle-flags#readme"
36
+ "homepage" : " https://github.com/HatScripts/circle-flags#readme" ,
37
+ "devDependencies" : {
38
+ "svgo" : " ^3.0.2"
39
+ },
40
+ "scripts" : {
41
+ "svgo" : " node_modules/.bin/svgo ./flags --recursive --config=svgo.config.js"
42
+ }
37
43
}
You can’t perform that action at this time.
0 commit comments