Skip to content

Commit 61ee7d7

Browse files
author
Zachary Eisinger
committed
Update contributors docs
1 parent 3af4b91 commit 61ee7d7

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

docs/contributors.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
# Contributors
22

3+
Thank you for contributing! This action is targetted around setting up the dotnet cli and related sdks for GitHub actions. As part of that we use proxy settings (for self-hosted runners) and set-up nuget authentication for private feeds.
34

4-
# Checkin
5+
If you would like to contribute there are a few things to consider:
56

6-
- Do checkin source (src)
7-
- Do checkin build output (lib)
8-
- Do checkin runtime node_modules
9-
- Do not checkin
7+
## Commands to use
108

11-
# Adding a dev dependency
9+
- npm run build - Compiles the action into a single js file at dist/index.js (Please check in the changes made by this command)
10+
- npm run test - Runs all tests under __tests__
11+
- npm run format - Runs formatting required to pass the lint test (Please check in the changes made by this command)
12+
- npm run update-installers - Updates the install-dotnet scripts in externals (Please check in the changes made by this command)
1213

13-
Remember to update .gitignore.
14+
## To check in or not to check in
1415

15-
# Updating toolkit dependency
16+
- Do check in source (src)
17+
- Do check in index file (dist)
18+
- Do check in updates to install-dotnet scripts (externals)
19+
- Do not check in build output (lib)
20+
- Do not check in runtime (node_modules)
1621

17-
Until released publically, update tgz packages in toolkit
22+
## Writing tests
23+
24+
With any contribution please take time to consider how this can be tested to maintain high quality. Current tests can be found in the folder __tests__ for examples.

0 commit comments

Comments
 (0)