You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Run test builds as necessary. Can be on this repository or elsewhere as needed in order to test the change - please include links to tests in other repos!
4
-
-[ ] CodeQL using init/analyze actions
5
-
-[ ] 3rd party tool using upload action
6
3
-[ ] Confirm this change is backwards compatible with existing workflows.
7
4
-[ ] Confirm the [readme](https://github.com/github/codeql-action/blob/master/README.md) has been updated if necessary.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20-1Lines changed: 20 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,32 @@ Contributions to this project are [released](https://help.github.com/articles/gi
10
10
11
11
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
12
12
13
+
## Development and Testing
14
+
15
+
Before you start, ensure that you have a recent version of node installed. You can see which version of node is used by the action in `init/action.yml`.
16
+
17
+
### Common tasks
18
+
19
+
* Transpile the TypeScript to JavaScript: `npm run build`. Note that the JavaScript files are committed to git.
20
+
* Run tests: `npm run test`. You’ll need to ensure that the JavaScript files are up-to-date first by running the command above.
21
+
* Run the linter: `npm run lint`.
22
+
23
+
### Running the action
24
+
25
+
To see the effect of your changes and to test them, push your changes in a branch and then look at the [Actions output](https://github.com/github/codeql-action/actions) for that branch. You can also exercise the code locally by running the automated tests.
26
+
27
+
### Integration tests
28
+
29
+
As well as the unit tests (see _Common tasks_ above), there are integration tests, defined in `.github/workflows/integration-testing.yml`. These are run by a CI check. Depending on the change you’re making, you may want to add a test to this file or extend an existing one.
30
+
13
31
## Submitting a pull request
14
32
15
33
1.[Fork][fork] and clone the repository
16
34
2. Create a new branch: `git checkout -b my-branch-name`
17
35
3. Make your change, add tests, and make sure the tests still pass
18
36
4. Push to your fork and [submit a pull request][pr]
19
-
5. Pat your self on the back and wait for your pull request to be reviewed and merged.
37
+
5. Pat yourself on the back and wait for your pull request to be reviewed and merged.
38
+
If you're a GitHub staff member, you can merge your own PR once it's approved; for external contributors, GitHub staff will merge your PR once it's approved.
20
39
21
40
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
0 commit comments