Skip to content

Commit f2e714e

Browse files
authored
add rest of instructions
1 parent 166ad9a commit f2e714e

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

CONTRIBUTING.md

+42-1
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ Whenever you are submitting any changes to the Generative AI for Beginners repos
3434

3535
- Ensure that all your URLs are wrapped in square brackets followed by a parenthesis with no extra spaces around them or inside them `[]()`.
3636
- Ensure that any relative link (i.e. links to other files and folders in the repository) starts with a `./` referring to a file or a folder located in the current working directory or a `../` referring to a file or a folder located in a parent working directory.
37+
- Ensure that any relative link (i.e. links to other files and folders in the repository) has a tracking ID (i.e. `?` or `&` then `wt.mc_id=` or `WT.mc_id=`) at the end of it.
38+
- Ensure that any URL from the following domains _github.com, microsoft.com, visualstudio.com, aka.ms, and azure.com_ has a tracking ID (i.e. `?` or `&` then `wt.mc_id=` or `WT.mc_id=`) at the end of it.
3739
- Ensure that your links don't have country specific locale in them (i.e. `/en-us/` or `/en/`).
38-
- Ensure that any URL from the following domains _github.com, microsoft.com, visualstudio.com, aka.ms, and azure.com_ has a tracking ID at the end of it (i.e. `?` or `&` then `wt.mc_id=` or `WT.mc_id=`).
3940
- Ensure that all images are stored in the `./images` folder.
4041
- Ensure that the images have descriptive names using English characters, numbers, and dashes in the name of your image.
4142

@@ -66,17 +67,57 @@ When you type `./` or `../` VS code will prompt you to choose from the available
6667
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/792c1bc1-4c3f-4ad4-a8c5-66dcf224f668)
6768
Follow the path by clicking on the desired file or folder and you will be sure that your path is not broken.
6869

70+
Once you add the correct relative path, save, and push your changes the workflow will be triggered again to verify your changes.
71+
If you pass the check then you are good to go.
72+
6973
### Check Paths Have Tracking
7074

7175
This workflow ensures that any relative path has tracking in it.
7276
This repository is deployed to GitHub pages so we need to track the movement between the different files and folders.
7377

78+
To make sure your relative paths have tracking in them simply check for the following text `?wt.mc_id` at the end of the path.
79+
If it's appended to your relative paths then you will pass this check.
80+
81+
If not, you may get the following error.
82+
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/d5e53a5a-d53d-4486-be80-1a9ed7115093)
83+
84+
To fix this issue, try to open the file path that the workflow highlighted and add the tracking ID to the end of the relative paths.
85+
86+
Once you add the tracking ID, save, and push your changes the workflow will be triggered again to verify your changes.
87+
If you pass the check then you are good to go.
88+
89+
7490
### Check URLs Have Tracking
7591

7692
This workflow ensures that any web URL has tracking in it.
7793
This repository is available to everyone so you need to make sure to track the access to know from where the traffic is coming.
7894

95+
To make sure your URLs have tracking in them simply check for the following text `?wt.mc_id` at the end of the path.
96+
If it's appended to your URLs then you will pass this check.
97+
98+
If not, you may get the following error.
99+
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/72d23ee5-180d-453c-a119-6b9011647a45)
100+
101+
102+
To fix this issue, try to open the file path that the workflow highlighted and add the tracking ID to the end of the URLs.
103+
104+
Once you add the tracking ID, save, and push your changes the workflow will be triggered again to verify your changes.
105+
If you pass the check then you are good to go.
106+
79107
### Check URLs Don't Have Locale
80108

81109
This workflow ensures that any web URL doesn't have country specific locale in it.
82110
This repository is available to everyone around the world so you need to make sure not to include your country's locale in URLs.
111+
112+
To make sure your URLs don't have country locale in them simply check for the following text `/en-us/` or `/en/` or any other language locale anywhere in the URL.
113+
If it's not present in your URLs then you will pass this check.
114+
115+
If not, you may get the following error.
116+
![image](https://github.com/john0isaac/generative-ai-for-beginners/assets/64026625/c261987b-f6eb-484e-a4a3-bab696828d62)
117+
118+
To fix this issue, try to open the file path that the workflow highlighted and remove the country locale from the URLs.
119+
120+
Once you remove the country locale, save, and push your changes the workflow will be triggered again to verify your changes.
121+
If you pass the check then you are good to go.
122+
123+
Congratulations! We will get back to you as soon as possible with feedback about your contribution.

0 commit comments

Comments
 (0)