[DOCS] Open source updates - #8
Conversation
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
There was a problem hiding this comment.
Pull request overview
This pull request adds essential open source project infrastructure and significantly improves documentation by streamlining it for better usability. It introduces standard governance files (LICENSE, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY, SUPPORT), automated dependency management via Dependabot, release note configuration, and comprehensive issue templates. The documentation has been condensed and reorganized to be more concise and actionable, with a new Extending Guide added to help contributors add support for new CI/CD platforms.
Changes:
- Added open source governance files (LICENSE, Code of Conduct, Contributing guidelines, Security policy, Support documentation)
- Configured Dependabot for automated GitHub Actions dependency updates
- Created structured issue templates for agents, knowledgebase, documentation, and automation improvements
- Streamlined and condensed documentation across README, deployment guide, and operations guide (reducing verbosity while maintaining key information)
- Added new Extending Guide to document how to add support for new CI/CD platforms
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| LICENSE | Adds MIT License for the project |
| CODE_OF_CONDUCT.md | Adds Contributor Covenant Code of Conduct |
| CONTRIBUTING.md | Provides contribution guidelines and workflow instructions |
| SECURITY.md | Documents security vulnerability reporting process |
| SUPPORT.md | Explains how to get help and file issues |
| .github/dependabot.yml | Configures automated dependency updates for GitHub Actions |
| .github/release.yml | Configures automatic release note generation with categorization |
| .github/ISSUE_TEMPLATE/*.md | Adds structured templates for different issue types (agents, knowledgebase, documentation, automation) |
| .github/ISSUE_TEMPLATE/config.yml | Disables blank issues and redirects general questions to Discussions |
| README.md | Significantly condensed and streamlined for clarity, updated structure and links |
| docs/deployment.md | Reduced from 424 to 238 lines by removing redundancy, maintaining essential deployment steps |
| docs/operations.md | Reduced from 305 to 186 lines by consolidating content into tables and concise sections |
| docs/extending.md | New guide documenting how to add support for new CI/CD platforms |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # macOS/Linux | ||
| find agents -name "*.md" -type f -exec sed -i '' 's/{MY_ORGANIZATION}/YOUR-ORG-SLUG/g' {} + | ||
|
|
There was a problem hiding this comment.
The sed command provided uses the macOS syntax (sed -i ''), which will not work on Linux systems. On Linux, the command should be sed -i (without the empty string). Consider providing both versions or using a more portable approach like sed -e 's/{MY_ORGANIZATION}/YOUR-ORG-SLUG/g' file > file.tmp && mv file.tmp file in a loop, or clarify that the command shown is macOS-only and provide the Linux alternative.
| # macOS/Linux | |
| find agents -name "*.md" -type f -exec sed -i '' 's/{MY_ORGANIZATION}/YOUR-ORG-SLUG/g' {} + | |
| # macOS (BSD sed) | |
| find agents -name "*.md" -type f -exec sed -i '' 's/{MY_ORGANIZATION}/YOUR-ORG-SLUG/g' {} + | |
| # Linux (GNU sed) | |
| find agents -name "*.md" -type f -exec sed -i 's/{MY_ORGANIZATION}/YOUR-ORG-SLUG/g' {} + |
|
|
||
| This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue. | ||
|
|
||
| For help or questions about using this project, please file an issue. |
There was a problem hiding this comment.
The SUPPORT.md file states "For help or questions about using this project, please file an issue" but the issue template configuration (.github/ISSUE_TEMPLATE/config.yml) disables blank issues and redirects general questions to GitHub Discussions. This creates inconsistent guidance for users. The SUPPORT.md should be updated to direct users to GitHub Discussions for questions, consistent with the issue template configuration.
| For help or questions about using this project, please file an issue. | |
| For help or questions about using this project, please use this project's GitHub Discussions page. |
| ## Next Steps | ||
| - **Migration Reports**: Start with `.github/ci-archive/MIGRATION-README.md` | ||
| - **Knowledgebase**: Review `knowledge/` in `.github-private` | ||
| - **Discussions**: [github.com/copilot/agents discussions](https://github.com/github/actions-migrations-via-copilot/discussions) |
There was a problem hiding this comment.
The link text "github.com/copilot/agents discussions" is misleading because it suggests it links to github.com/copilot/agents, but the actual URL is to github.com/github/actions-migrations-via-copilot/discussions. The link text should be updated to clearly indicate it links to this project's discussions, not the Copilot agents interface.
| - **Discussions**: [github.com/copilot/agents discussions](https://github.com/github/actions-migrations-via-copilot/discussions) | |
| - **Discussions**: [github.com/github/actions-migrations-via-copilot discussions](https://github.com/github/actions-migrations-via-copilot/discussions) |
| @@ -0,0 +1,21 @@ | |||
| MIT License | |||
|
|
|||
| Copyright GitHub, Inc. | |||
There was a problem hiding this comment.
The LICENSE file is missing a copyright year. Standard practice for MIT licenses is to include the year or year range (e.g., "Copyright (c) 2024 GitHub, Inc." or "Copyright (c) 2024-present GitHub, Inc."). This helps establish when the copyright was first claimed and is important for legal clarity.
| Copyright GitHub, Inc. | |
| Copyright (c) 2024 GitHub, Inc. |
This pull request introduces essential open source project files and templates to improve project governance, contribution workflows, and issue reporting. It adds a license, a code of conduct, a contributing guide, configuration for automated dependency updates and release notes, and a comprehensive set of issue templates for different areas of the project.