Skip to content

Add GitHub workflows and review documentation for Copilot exercises #14

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 2 commits into from
Apr 7, 2025

Conversation

arilivigni
Copy link
Contributor

  • Create x-review.md for summarizing exercise completion and next steps.
  • Update 0-start-exercise.yml to correct intro message and adjust button activation.
  • Implement 1-preparing.yml for initial setup of the extension.
  • Add 2-application-initial-setup.yml for setting up the application.
  • Create 3-database-django-project-setup.yml for Django project setup and validation.
  • Implement 4-setup-django-rest-framework.yml for setting up Django REST framework.
  • Add 5-setup-frontend-react-framework.yml for frontend React framework setup.
  • Create 6-copilot-on-github.yml for final review and exercise completion.
  • Add 6b-copilot-on-github.yml for handling Copilot review comments on pull requests.
    This pull request includes various updates to the GitHub Copilot tutorial steps, focusing on improving clarity, fixing typos, and enhancing user guidance. The most important changes include adding troubleshooting details, correcting grammatical errors, and ensuring consistency in terminology.

Improvements to user guidance:

Corrections and consistency:

- Create x-review.md for summarizing exercise completion and next steps.
- Update 0-start-exercise.yml to correct intro message and adjust button activation.
- Implement 1-preparing.yml for initial setup of the extension.
- Add 2-application-initial-setup.yml for setting up the application.
- Create 3-database-django-project-setup.yml for Django project setup and validation.
- Implement 4-setup-django-rest-framework.yml for setting up Django REST framework.
- Add 5-setup-frontend-react-framework.yml for frontend React framework setup.
- Create 6-copilot-on-github.yml for final review and exercise completion.
- Add 6b-copilot-on-github.yml for handling Copilot review comments on pull requests.
@arilivigni arilivigni requested a review from Copilot April 7, 2025 12:10
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates and adds several GitHub workflows and documentation files for Copilot exercises to enhance clarity, fix typographical errors, and improve user guidance.

  • Introduces new workflows for automated Copilot review feedback.
  • Updates step instructions and troubleshooting sections for consistency and grammatical correctness.
  • Adjusts prompt examples and naming conventions across the documentation.

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
.github/workflows/6b-copilot-on-github.yml Added workflow for Copilot review comment handling.
.github/workflows/6-copilot-on-github.yml Added workflow for final pull request review and commenting.
.github/workflows/5-setup-frontend-react-framework.yml Introduced frontend workflow and updated response and check steps.
.github/workflows/4-setup-django-rest-framework.yml Added workflow for setting up the Django REST framework.
.github/workflows/3-database-django-project-setup.yml Added workflow for Django project setup and database population.
.github/workflows/2-application-initial-setup.yml Added workflow for the initial setup of the application.
.github/workflows/1-preparing.yml Added workflow for preparation step and branch creation.
.github/workflows/0-start-exercise.yml Updated exercise start workflow with improved messaging.
.github/steps/x-review.md Created review documentation for summarizing exercises.
.github/steps/6-copilot-on-github.md Added documentation for Copilot usage within pull requests.
.github/steps/5-setup-frontend-react-framework.md Updated frontend documentation with corrected prompt texts and images.
.github/steps/4-setup-django-rest-framework.md Updated instructions and troubleshooting for the Django REST setup.
.github/steps/3-database-django-project-setup.md Updated prompts and instructions for database and project setup.
.github/steps/2-application-initial-setup.md Updated application setup instructions with minor text changes.
.github/steps/1-preparing.md Revised preparation instructions and next-step guidance.
Comments suppressed due to low confidence (1)

.github/steps/5-setup-frontend-react-framework.md:32

  • [nitpick] The proper noun for the high school appears inconsistently as 'mergington's'; please verify and use the correct, consistent spelling (e.g. 'Merington's') throughout the documentation.
> Based on the example monafit tracker app in the docs/mona-high-school-fitness-tracker.md file and use octofit as the name for mergington's high schools app.

Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more

@arilivigni arilivigni merged commit 8dc70da into main Apr 7, 2025
@arilivigni arilivigni deleted the issue-based branch April 7, 2025 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant