setup-dotnet/docs/contributors.md

# Contributors

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.

If you would like to contribute there are a few things to consider:

## Commands to use

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

## To check in or not to check in

- Do check in source (src)
- Do check in index file (dist)
- Do check in updates to install-dotnet scripts (externals)
- Do not check in build output (lib)
- Do not check in runtime (node_modules)

## Writing tests

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.

## Creating new version

Details on versioning can be found here: https://github.com/actions/toolkit/blob/main/docs/action-versioning.md
Create a new release using the UI. Version format should be `v1.x.x`. Creating a new major version requires reaction from users and should be done only with breaking changes.
Once the new release is created, the v1 tag needs to be updated as well.
```
git tag -fa v1 -m "Update v1 tag"
git push origin v1 --force
```
Initial commit 2019-06-20 04:22:22 +08:00			`# Contributors`

Update contributors docs 2020-07-16 23:20:11 +08:00			`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.`
Initial commit 2019-06-20 04:22:22 +08:00
Update contributors docs 2020-07-16 23:20:11 +08:00			`If you would like to contribute there are a few things to consider:`
Initial commit 2019-06-20 04:22:22 +08:00
Update contributors docs 2020-07-16 23:20:11 +08:00			`## Commands to use`
Initial commit 2019-06-20 04:22:22 +08:00
Update contributors docs 2020-07-16 23:20:11 +08:00			`- npm run build - Compiles the action into a single js file at dist/index.js (Please check in the changes made by this command)`
			`- npm run test - Runs all tests under __tests__`
			`- npm run format - Runs formatting required to pass the lint test (Please check in the changes made by this command)`
			`- npm run update-installers - Updates the install-dotnet scripts in externals (Please check in the changes made by this command)`
Initial commit 2019-06-20 04:22:22 +08:00
Update contributors docs 2020-07-16 23:20:11 +08:00			`## To check in or not to check in`
Initial commit 2019-06-20 04:22:22 +08:00
Update contributors docs 2020-07-16 23:20:11 +08:00			`- Do check in source (src)`
			`- Do check in index file (dist)`
			`- Do check in updates to install-dotnet scripts (externals)`
			`- Do not check in build output (lib)`
			`- Do not check in runtime (node_modules)`
Initial commit 2019-06-20 04:22:22 +08:00
Update contributors docs 2020-07-16 23:20:11 +08:00			`## Writing tests`

			`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.`
Update contributors.md 2020-10-09 01:51:05 +08:00
			`## Creating new version`

			`Details on versioning can be found here: https://github.com/actions/toolkit/blob/main/docs/action-versioning.md`
			Create a new release using the UI. Version format should be `v1.x.x`. Creating a new major version requires reaction from users and should be done only with breaking changes.
			`Once the new release is created, the v1 tag needs to be updated as well.`
			```
			`git tag -fa v1 -m "Update v1 tag"`
			`git push origin v1 --force`
			```