Skip to content

Commit e8970f9

Browse files
committed
Add overview and best practice
1 parent ec430d1 commit e8970f9

File tree

3 files changed

+30
-3
lines changed

3 files changed

+30
-3
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Custom GitHub Copilot workshop with Python Django, ReactJS, and PostgreSQL stacks
22

3-
Welcome to a custom Copilot workshop prepared by GitHub’s Expert Service team! In this workshop, you will get to deliver a custom Copilot workshop that can help to build a full stack web application that involves a front end layer using ReactJS, a backend layer using Python Django, and a database layer using PostgreSQL. Because
3+
![GitHub Copilot Workshop](./images/cover-copilot.jpg)
4+
5+
Welcome to a custom Copilot workshop prepared by **GitHub’s Expert Service team**!
6+
7+
In this workshop, you will get to deliver a custom Copilot workshop that can help to build a full stack web application that involves a front end layer using ReactJS, a backend layer using Python Django, and a database layer using PostgreSQL.
8+
9+
Because this workshop involves several technology stacks, it is essential that you need to meet prerequisites as outlined from [Before getting started](docs/2_BeforeGettingStarted/README.md) if you want to follow along. Otherwise, you can always listen to what GitHub Expert Service team's instructor demo to see how it works in practice.
10+
11+
Without further ado, let's get started.
412

513
## Table of Contents
614

docs/6_BuildReactJS/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Then, when you save to reload your ReactJS web page, your updated ReactJS page m
102102
We can further parse those data to make them look prettier, but, for now, let’s focus on whether we can put those data into a nice table instead of a simple list. Select those HTML tags that print the data, and let’s ask this question in our GitHub Copilot Chat.
103103
104104
```bash
105-
How can I put those highlighted codes into a nice bootstrap table instead??
105+
How can I put those highlighted codes into a nice bootstrap table instead?
106106
```
107107
108108
![Print Table](./images/15_PrintTable.jpg)

docs/7_LessonsLearned/README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
11
# Best practices and lessons learned from GitHub Copilot Workshop
22

3-
Throughout this workshop, you have learned
3+
Congratulation on finishing this GitHub Copilot worshop! Hopefully, this workshop session was useful to understand how GitHub Copilot works in practice when you work with a full stack project.
4+
5+
## What you have learned
6+
7+
Here is a summary of what you have learned.
8+
9+
- You used GitHub Copilot Chat in conjunction with GitHub Copilot's file functionalities to intelligently build a full end-to-end Python Django, PostgreSQL, and ReactJS stacks application.
10+
- You know when to take GitHub Copilot's suggestions and how to use prompt engineering to get right answers first time.
11+
12+
## Best practices with GitHub Copilot
13+
14+
Although GitHub Copilot keeps getting improved, here some general suggestions when you with GitHub Copilot, and many of these practices involve art of mastering **prompt engineering.**
15+
16+
- When you ask GitHub Copilot within file as comments or function names, try to be detailed as much as possible if you want GitHub Copilot to get it right first time. You can always override the suggestions given by GitHub Copilot.
17+
- When you ask GitHub Copilot Chat, start with something simple and have a conversation with GitHub Copilot to provide more contexts as you keep checking if suggestions are correct. For example, don't start with something like `Can you help me to create a ReactJS application that works with my Python Django application and retrieves data in a table format?` Most likely, you will get some irrelevant result from GitHub Copilot Chat. Instead, try to start with `Can you help me to create a ReactJS application` and give more contexts to build your work toward building projects that you have in mind.
18+
- Don't always 100% trust what GitHub Copilot make a suggestion to you, and always use your judgement to see what is right or wrong. Again, you are the main developer while your GitHub Copilot is just your assistance pilot.
19+
20+
I can add more stuffs, but this is just your start of journey. Congratulation on finishing your GitHub Copilot workshop course!
21+
22+
![Congratulation](./images/congrat.jpg)

0 commit comments

Comments
 (0)