-
Notifications
You must be signed in to change notification settings - Fork 97
Initial thoughts on contributing.md #201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Contributing | ||
|
|
||
| This repo contains a dev container that is intended to be used for developing the project. | ||
|
|
||
| As a general rule, it is recommended that you create an issue to discuss proposed changes/features before investing too much effort implementing it. For small changes/fixes, it may be easier to just create a PR and discuss it there. | ||
|
|
||
| ## Repo Structure | ||
|
|
||
| The repo contains code for both a GitHub action and Azure DevOps Pipeline Task. | ||
| The code for each is contained in a separate folder. | ||
|
|
||
| The main folders in the repo are: | ||
|
|
||
| | Folder | Description | | ||
| | --------------- | ---------------------------------------------------------------------------------------------- | | ||
| | `azdo-task` | Code for the Azure DevOps Pipeline Task | | ||
| | `common` | Common code used by both the GitHub Action and Azure DevOps Pipeline Task | | ||
| | `docs` | Documentation for using the action/task | | ||
| | `github-action` | Code for the GitHub Action | | ||
| | `github-tests` | This folder contains various test projects that are used by the CI for GitHub and Azure DevOps | | ||
|
|
||
|
|
||
| ## Workflow | ||
|
|
||
| The code for both the GitHub Action and Azure DevOps Pipeline Task is written in TypeScript. Since the GitHub action is pulled from the project repo when executed, any PRs should also include the output of the build process. | ||
|
|
||
| To run the build step locally, run `./scripts/build.sh` from the root of the repo. | ||
|
|
||
| The intention is for the GitHub action and Azure DevOps task to maintain feature parity as far as possible. As a general rule, and changes should be implemented in both the GitHub action and the Azure DevOps task. | ||
|
|
||
| Additionally, it is desirable to add new tests to cover any new functionality. | ||
|
|
||
| When a PR is created, some tests will be automatically triggered against the PR. The full suite of tests requires secrets and needs to be triggered by a maintainer. | ||
|
|
||
| ## Miscellaneous | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
|
|
||
| This project is under an [MIT license](LICENSE.txt). | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.