docs(contribute): replace Azure DevOps references with GitHub equivalents#198
docs(contribute): replace Azure DevOps references with GitHub equivalents#198Dejmenek wants to merge 6 commits intomicrosoft:mainfrom
Conversation
|
@microsoft-github-policy-service agree |
There was a problem hiding this comment.
Pull request overview
This PR migrates CONTRIBUTING.md from Azure DevOps references to GitHub-native equivalents, addressing issue #194. The changes replace 7 internal Azure DevOps organization URLs with publicly accessible GitHub URLs and update ADO-specific workflow language to use GitHub terminology and conventions.
Changes:
- Replaced all Azure DevOps organization URLs (
dev.azure.com) with GitHub repository URLs - Updated tracking system references from "Azure DevOps issues/Features" to "GitHub Issues"
- Removed "internal Stack Overflow" reference to reflect OSS project status
- Fixed documentation paths for MegaLinter and Coding Conventions guides
| - Make sure that you are using the latest version. | ||
| - Read the [documentation](./docs/README.md) carefully and find out if the functionality is already covered, maybe by an individual configuration. | ||
| - Perform a [search](https://dev.azure.com/ai-at-the-edge-flagship-accelerator/IaC%20for%20the%20Edge/_workitems/) to see if the enhancement has already been suggested. If it has, add a comment to the existing workitem instead of opening a new one. | ||
| - Perform a [search](https://github.com/microsoft/edge-ai/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing workitem instead of opening a new one. |
There was a problem hiding this comment.
The term "workitem" is Azure DevOps-specific terminology. For consistency with the GitHub migration, this should be changed to "issue" to match GitHub's terminology. The sentence should read "add a comment to the existing issue instead of opening a new one."
CONTRIBUTING.md
Outdated
| - Commits (or at least one in a commit chain) should reference a User Story or Task item from the backlog for traceability. | ||
| - When creating a PR, ensure descriptions use [Azure DevOps notation to close associated work items](https://learn.microsoft.com/azure/devops/repos/git/resolution-mentions?view=azure-devops). | ||
| - Assign the GitHub Issue to yourself before beginning any effort, and set the item's status field accordingly. | ||
| - If a work item for your contribution does not exist, [please file an issue](https://github.com/microsoft/edge-ai/issues/new/choose) first to engage the project's PO, TPM, or Tech Lead for guidance. |
There was a problem hiding this comment.
The term "work item" is Azure DevOps-specific terminology. For consistency with the GitHub migration, this should be changed to "GitHub issue" or simply "issue" to match GitHub's terminology. The sentence should read "If a GitHub issue for your contribution does not exist" or "If an issue for your contribution does not exist".
| - If a work item for your contribution does not exist, [please file an issue](https://github.com/microsoft/edge-ai/issues/new/choose) first to engage the project's PO, TPM, or Tech Lead for guidance. | |
| - If a GitHub issue for your contribution does not exist, [please file an issue](https://github.com/microsoft/edge-ai/issues/new/choose) first to engage the project's PO, TPM, or Tech Lead for guidance. |
1 participant
Pull Request
Description
I replaced Azure DevOps organization URLs with GitHub-native equivalents, fixed broken links for MegaLinter and Coding Conventions, rewrote ADO workflow language for GitHub-native workflows and removed the "internal Stack Overflow" reference.
Related Issue
Closes #194
Type of Change
Testing Performed