File tree Expand file tree Collapse file tree 1 file changed +37
-6
lines changed Expand file tree Collapse file tree 1 file changed +37
-6
lines changed Original file line number Diff line number Diff line change @@ -62,28 +62,54 @@ pass the default token with the `repo-token` variable:
62
62
` ` `
63
63
64
64
65
- # # Development
65
+ # # Development workflow
66
+
67
+ # ## 1. Install tools
68
+
69
+ # ### Node.js
70
+
71
+ [**npm**](https://www.npmjs.com/) is used for dependency management.
72
+
73
+ Follow the installation instructions here:<br />
74
+ https://nodejs.dev/en/download
75
+
76
+ # ## 2. Install dependencies
66
77
67
78
To work on the codebase you have to install all the dependencies :
68
79
69
80
` ` `
70
81
npm install
71
82
` ` `
72
83
84
+ # ## 3. Coding
85
+
86
+ Now you're ready to work some [TypeScript](https://www.typescriptlang.org/) magic!
87
+
88
+ Make sure to write or update tests for your work when appropriate.
89
+
90
+ # ## 4. Format code
91
+
92
+ Format the code to follow the standard style for the project :
93
+
94
+ ` ` `
95
+ npm run format
96
+ ` ` `
97
+
98
+ # ## 5. Run tests
99
+
73
100
To run the tests :
74
101
75
102
` ` `
76
103
npm run test
77
104
` ` `
78
105
79
- # # Enable verbose logging for a pipeline
80
- Additional log events with the prefix ::debug: : can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
81
-
82
- See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
106
+ # ## 6. Commit
83
107
108
+ Everything is now ready to make your contribution to the project, so commit it to the repository and submit a pull request.
84
109
110
+ Thanks!
85
111
86
- # # Release
112
+ # # Release workflow
87
113
88
114
We check in the `node_modules` to provide runtime dependencies to the system
89
115
using the Action, so be careful not to `git add` all the development dependencies
@@ -104,6 +130,11 @@ Action the workflow should be the following:
104
130
If no branch exists for the release's major version, create one.
105
131
106
132
133
+ # # Enable verbose logging for a pipeline
134
+ Additional log events with the prefix ::debug: : can be enabled by setting the secret `ACTIONS_STEP_DEBUG` to `true`.
135
+
136
+ See [step-debug-logs](https://github.com/actions/toolkit/blob/master/docs/action-debugging.md#step-debug-logs) for reference.
137
+
107
138
108
139
# # Security
109
140
You can’t perform that action at this time.
0 commit comments