Skip to content

Commit 7c0a4f3

Browse files
authored
Merge pull request #35882 from github/repo-sync
Repo sync
2 parents fd57f0f + fc0f294 commit 7c0a4f3

File tree

16 files changed

+10165
-888
lines changed

16 files changed

+10165
-888
lines changed

.github/workflows/sync-audit-logs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
# need to use a token from a user with access to github/audit-log-allowlists for this step
3434
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
3535
run: |
36-
npm run audit-log-sync
36+
npm run sync-audit-log
3737
3838
- name: Get the audit-log-allowlists SHA being synced
3939
id: audit-log-allowlists

.github/workflows/sync-graphql.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
env:
2626
# need to use a token from a user with access to github/github for this step
2727
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
28-
run: npm run graphql-sync
28+
run: npm run sync-graphql
2929
- name: Create pull request
3030
id: create-pull-request
3131
uses: peter-evans/create-pull-request@6cd32fd93684475c31847837f87bb135d40a2b79 # pin @v7.0.3

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ children:
1717
- /managing-your-profile-readme
1818
- /pinning-items-to-your-profile
1919
- /setting-your-profile-to-private
20+
- /using-your-github-profile-to-enhance-your-resume
2021
---
21-
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: Using your GitHub profile to enhance your resume
3+
intro: 'Demonstrate your skills to hiring managers with your {% data variables.product.github %} profile.'
4+
versions:
5+
fpt: '*'
6+
topics:
7+
- Profiles
8+
shortTitle: Enhance your resume
9+
---
10+
11+
## How can my {% data variables.product.github %} profile enhance my resume?
12+
13+
When you include a link to your {% data variables.product.github %} profile in your resume, you showcase your skills and experience to potential employers. In this article, you'll find practical tips for preparing your {% data variables.product.github %} profile for a job search.
14+
15+
After you complete these steps, you can be confident that hiring managers will have a good sense of your technical skills when they are reviewing your {% data variables.product.github %} profile.
16+
17+
## Step 1: Create a professional bio
18+
19+
Your bio is a sentence or two that appears under your profile picture. Use your bio to give potential employers a high-level overview of who you are and what kind of work you're looking for.
20+
21+
Navigate to your [profile settings](https://github.com/settings/profile) to update your bio. Keep this description short and concise. Consider something like, "Hello! My name is Mona and I'm looking for work as a front end developer."
22+
23+
> [!NOTE] While you're here, you can update the rest of your profile settings. Consider including a profile picture, a link to your personal website or portfolio, and links to your social profiles.
24+
25+
## Step 2: Create a profile README
26+
27+
Compared to your bio, your profile README is flexible and allows for more creativity. You can write more in your profile README to showcase your skills and interests.
28+
29+
Things you may want to add to your profile README include:
30+
31+
* **An introduction**: Write a brief introduction of yourself and your professional background.
32+
* **Skills and experience**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in.
33+
* **Your professional experience**: Describe where you've worked before and what sort of professional skills you've built. These can even be non-technical skills, such as communication and empathy.
34+
* **Some of your best projects**: Describe some projects you're proud of. You'll also pin these repositories later, but your README gives you a chance to provide more commentary.
35+
* **Achievements or awards**: Show off any of your achievements, including certifications or awards you've received for your work.
36+
37+
For instructions for creating a profile README, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme).
38+
39+
> [!NOTE] Updating and customizing your profile README also helps demonstrate fluency using Markdown and HTML, which are useful skills for technical jobs. To show off your skills for potential employers, look for ways to use more advanced Markdown or HTML elements in your profile README.
40+
41+
## Step 3: Choose projects to showcase
42+
43+
Pick your favorite 3-5 projects to highlight for your job application. For the best chances at an interview, pick projects that show your diverse skills and are relevant to your specific job search.
44+
45+
These can be projects you created or projects that you contributed to:
46+
47+
* Projects you own are fully under your control, so you can prepare the project using the rest of the steps below.
48+
* Open source projects highlight your ability to collaborate with others.
49+
50+
To take advantage of both, pin some of each to your profile.
51+
52+
Repositories you pin will be prominently displayed on your profile, allowing you to direct hiring managers' attention to the projects you're most proud of.
53+
54+
To get started, click **Customize your pins** in the "Popular repositories" section of your profile.
55+
56+
## Step 4: Prepare the projects you want to showcase
57+
58+
Hiring managers usually consider many applicants for each role. Expect that they will only look at your projects for a couple minutes. To give the best impression during this brief time, you should make your projects easy to understand and explore.
59+
60+
Below, you'll find some practical suggestions for preparing your showcase projects, as well as some tips on using {% data variables.product.prodname_copilot_short %} to help.
61+
62+
> [!NOTE] Always verify the answers that {% data variables.product.prodname_copilot_short %} provides.
63+
64+
### Update the repository details
65+
66+
On the main page of the repository, to the right of "About," click {% octicon "gear" aria-label="Edit repository metadata" %}. Here, you can provide information that helps hiring managers quickly understand the project:
67+
* A brief description of your project
68+
* A website where you can see the project in action
69+
* Topic tags that categorize your project
70+
71+
### Write a helpful README
72+
73+
The README for your project's repository is a perfect space to give a concise project overview. Helpful project README details include:
74+
* A list of key features of the project
75+
* Details on how to set up and run the project
76+
* An example or demo of the project
77+
* Instructions on testing your code
78+
79+
You can use [Copilot Chat](https://github.com/copilot) to help write your README. Use a prompt like this:
80+
>Write a README for my `lottery-number-generator` repository.
81+
82+
### Make the code easy to understand
83+
84+
To give the best impression, you'll want to make sure that hiring managers can understand your project quickly. In general, a few best practices can help give any readers an understanding of your project and how you work with code:
85+
86+
* Maintain a consistent coding style with descriptive file and directory names throughout the project
87+
* Use helpful comments and documentation for any complex or important snippets
88+
* Refine your code according to popular style guides
89+
* Simplify complex functions, break down large classes, and remove redundant code
90+
* Provide tests to validate that your code is working as expected
91+
92+
You can use [{% data variables.product.prodname_copilot_extension_vsc %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) to interact with {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vscode_shortname %}. Here, {% data variables.product.prodname_copilot_short %} can help answer more specific questions about your project, make edits across multiple files, provide suggestions for simplifying your code, and write tests. For more information, see [AUTOTITLE](/copilot/using-github-copilot/guides-on-using-github-copilot/writing-tests-with-github-copilot).
93+
94+
### Update your project's dependencies
95+
96+
To showcase your understanding of security best practices, ensure your project is using the latest versions of any dependencies. You can use {% data variables.product.prodname_dependabot_alerts %} and security updates to view alerts about dependencies with known security vulnerabilities. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).
97+
98+
## Looking forward: Maintaining your projects
99+
100+
Your profile is now ready to be included on your resume! The changes you made today will have a big impact on your job search and will make your {% data variables.product.github %} profile stand out to hiring managers.
101+
102+
If you want to improve your profile even more, incorporate these practices into your coding routines:
103+
104+
* **Maintain a clean commit history**. To make your project history understandable, use descriptive commit messages and work in smaller batches.
105+
* **Use issues, pull requests, and {% data variables.product.prodname_projects_v2 %}**. Showcase your task management and project planning skills by tracking bugs and feature requests with issues and using {% data variables.product.prodname_projects_v2 %} to organize them.
106+
* **Keep dependencies updated**. Use {% data variables.product.prodname_dependabot_version_updates %} to automatically update your project's dependencies with the latest security features and bug fixes.
107+
* **Contribute to open source**. Open source contributions showcase your collaboration skills and prove that you can work in complex code bases. For more information, see [AUTOTITLE](/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github).

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
"analyze-text": "tsx src/search/scripts/analyze-text.ts",
2121
"analyze-comment": "tsx src/events/scripts/analyze-comment-cli.ts",
2222
"archive-version": "tsx --max-old-space-size=16384 src/ghes-releases/scripts/archive-version.ts",
23-
"audit-log-sync": "tsx src/audit-logs/scripts/sync.ts",
2423
"build": "next build",
2524
"check-canary-slots": "tsx src/workflows/check-canary-slots.ts",
2625
"check-content-type": "tsx src/workflows/check-content-type.ts",
@@ -49,7 +48,6 @@
4948
"general-search-scrape-server": "cross-env NODE_ENV=production PORT=4002 MINIMAL_RENDER=true CHANGELOG_DISABLED=true tsx src/frame/server.ts",
5049
"ghes-release-scrape-with-server": "cross-env GHES_RELEASE=1 start-server-and-test general-search-scrape-server 4002 general-search-scrape",
5150
"general-search-scrape-with-server": "cross-env NODE_OPTIONS='--max_old_space_size=8192' start-server-and-test general-search-scrape-server 4002 general-search-scrape",
52-
"graphql-sync": "tsx src/graphql/scripts/sync.js",
5351
"index": "tsx src/search/scripts/index/index-cli autocomplete docs-internal-data",
5452
"index-ai-search-autocomplete": "tsx src/search/scripts/index/index-cli ai-search-autocomplete",
5553
"index-general-autocomplete": "tsx src/search/scripts/index/index-cli general-autocomplete",
@@ -88,6 +86,8 @@
8886
"start-all-languages": "cross-env NODE_ENV=development tsx src/frame/server.ts",
8987
"start-for-playwright": "cross-env ROOT=src/fixtures/fixtures TRANSLATIONS_FIXTURE_ROOT=src/fixtures/fixtures/translations ENABLED_LANGUAGES=en,ja NODE_ENV=test tsx src/frame/server.ts",
9088
"symlink-from-local-repo": "tsx src/early-access/scripts/symlink-from-local-repo.js",
89+
"sync-audit-log": "tsx src/audit-logs/scripts/sync.ts",
90+
"sync-graphql": "tsx src/graphql/scripts/sync.js",
9191
"sync-rest": "tsx src/rest/scripts/update-files.ts",
9292
"sync-secret-scanning": "tsx src/secret-scanning/scripts/sync.ts",
9393
"sync-webhooks": "npx tsx src/rest/scripts/update-files.ts -o webhooks",

src/audit-logs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The workflow runs the `src/audit-logs/scripts/sync.ts` script.
4040

4141
To run the audit log events pipeline locally:
4242

43-
1. Run `npm run audit-log-sync`
43+
1. Run `npm run sync-audit-log`
4444

4545
## About this directory
4646

0 commit comments

Comments
 (0)