-
Notifications
You must be signed in to change notification settings - Fork 679
docs: restructure playbook & add AI-assisted engineering guidance #1130
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
Open
vdstrizhkova
wants to merge
13
commits into
microsoft:main
Choose a base branch
from
vdstrizhkova:feat/adding-ai-guidance
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
c4e6019
docs: add AI-assisted engineering guidance (synthesis of patch + brai…
8d88657
Restructed and reorder of the repo
3e8e514
fixing tone of voice
f15e29f
restructuring the start here section
33d7718
deleted file
d6866e4
chore: remove .copilot-tracking artifacts and ignore them
56fb30a
Fix MegaLinter findings in docs and config
9558b45
temporarily disabling lychee as it is pulling too
aee38d9
Potential fix for pull request finding
vdstrizhkova 06862f9
Removed agentic workflow from the PR
bf286b0
Adding more details on project readiness
eb8d26b
Add AI-assisted engineering checklist guidance
4492145
adding details
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
Some comments aren't visible on the classic Files Changed page.
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
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
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
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 |
|---|---|---|
|
|
@@ -345,3 +345,6 @@ _site | |
| site/ | ||
| mkdocs/ | ||
| megalinter-reports/ | ||
|
|
||
| # Copilot agent tracking artifacts | ||
| .copilot-tracking/ | ||
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
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
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 |
|---|---|---|
| @@ -1,10 +1,19 @@ | ||
| nav: | ||
| - ISE Engineering Fundamentals Playbook: README.md | ||
| - Engineering Fundamentals Checklist: engineering-fundamentals-checklist.md | ||
| - The First Week of an ISE Project: the-first-week-of-an-ise-project.md | ||
| - Start Here: start-here | ||
| - Who is ISE?: ISE.md | ||
| - Agile Development: agile-development | ||
| - Source Control: source-control | ||
| - Code Reviews: code-reviews | ||
| - Automated Testing: automated-testing | ||
| - CI/CD: CI-CD | ||
| - ... | ||
| - AI-Assisted Engineering: ai-assisted-engineering | ||
| - Security: security | ||
| - Observability: observability | ||
| - Agile Development: agile-development | ||
| - Design: design | ||
| - Developer Experience: developer-experience | ||
| - Documentation: documentation | ||
| - Engineering Feedback: engineering-feedback | ||
| - Non-Functional Requirements: non-functional-requirements | ||
| - ML & AI Projects: ml-and-ai-projects | ||
| - UI/UX: UI-UX |
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
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
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 |
|---|---|---|
|
|
@@ -9,6 +9,8 @@ An engineer working for a [ISE](ISE.md) project... | |
|
|
||
| This is our playbook. All contributions are welcome! Please feel free to submit a pull request to get involved. | ||
|
|
||
| New here? Start with [How to use this playbook](start-here/README.md), then choose the guide for your role. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how about Start Here
|
||
|
|
||
| ## Why Have a Playbook | ||
|
|
||
| * To increase overall efficiency for team members and the whole team in general. | ||
|
|
@@ -17,7 +19,9 @@ This is our playbook. All contributions are welcome! Please feel free to submit | |
|
|
||
| If you do nothing else follow the [Engineering Fundamentals Checklist](./engineering-fundamentals-checklist.md)! | ||
|
|
||
| The [first week of an ISE project](./the-first-week-of-an-ise-project.md) is a breakdown of the sections of the playbook according to the structure of an Agile sprint. | ||
| The [project kickoff checklist](./start-here/project-kickoff-checklist.md) is a breakdown of the sections of the playbook according to the structure of an Agile sprint. | ||
|
|
||
| Use [AI-Assisted Engineering](./ai-assisted-engineering/README.md) as the shared baseline for using AI tools in engineering work while preserving human ownership, validation, security, privacy, accessibility, and project governance. | ||
|
|
||
| ## General Guidance | ||
|
|
||
|
|
||
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
Oops, something went wrong.
Oops, something went wrong.
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.