forked from github/docs
-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request github#35882 from github/repo-sync
Repo sync
- Loading branch information
Showing
16 changed files
with
10,165 additions
and
888 deletions.
There are no files selected for viewing
This file contains 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 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 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
107 changes: 107 additions & 0 deletions
107
...le/customizing-your-profile/using-your-github-profile-to-enhance-your-resume.md
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| --- | ||
| title: Using your GitHub profile to enhance your resume | ||
| intro: 'Demonstrate your skills to hiring managers with your {% data variables.product.github %} profile.' | ||
| versions: | ||
| fpt: '*' | ||
| topics: | ||
| - Profiles | ||
| shortTitle: Enhance your resume | ||
| --- | ||
|
|
||
| ## How can my {% data variables.product.github %} profile enhance my resume? | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| ## Step 1: Create a professional bio | ||
|
|
||
| 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. | ||
|
|
||
| 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." | ||
|
|
||
| > [!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. | ||
| ## Step 2: Create a profile README | ||
|
|
||
| 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. | ||
|
|
||
| Things you may want to add to your profile README include: | ||
|
|
||
| * **An introduction**: Write a brief introduction of yourself and your professional background. | ||
| * **Skills and experience**: List your technical skills, including any programming languages, frameworks, and tools you are proficient in. | ||
| * **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. | ||
| * **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. | ||
| * **Achievements or awards**: Show off any of your achievements, including certifications or awards you've received for your work. | ||
|
|
||
| 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). | ||
|
|
||
| > [!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. | ||
| ## Step 3: Choose projects to showcase | ||
|
|
||
| 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. | ||
|
|
||
| These can be projects you created or projects that you contributed to: | ||
|
|
||
| * Projects you own are fully under your control, so you can prepare the project using the rest of the steps below. | ||
| * Open source projects highlight your ability to collaborate with others. | ||
|
|
||
| To take advantage of both, pin some of each to your profile. | ||
|
|
||
| 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. | ||
|
|
||
| To get started, click **Customize your pins** in the "Popular repositories" section of your profile. | ||
|
|
||
| ## Step 4: Prepare the projects you want to showcase | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| > [!NOTE] Always verify the answers that {% data variables.product.prodname_copilot_short %} provides. | ||
| ### Update the repository details | ||
|
|
||
| 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: | ||
| * A brief description of your project | ||
| * A website where you can see the project in action | ||
| * Topic tags that categorize your project | ||
|
|
||
| ### Write a helpful README | ||
|
|
||
| The README for your project's repository is a perfect space to give a concise project overview. Helpful project README details include: | ||
| * A list of key features of the project | ||
| * Details on how to set up and run the project | ||
| * An example or demo of the project | ||
| * Instructions on testing your code | ||
|
|
||
| You can use [Copilot Chat](https://github.com/copilot) to help write your README. Use a prompt like this: | ||
| >Write a README for my `lottery-number-generator` repository. | ||
| ### Make the code easy to understand | ||
|
|
||
| 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: | ||
|
|
||
| * Maintain a consistent coding style with descriptive file and directory names throughout the project | ||
| * Use helpful comments and documentation for any complex or important snippets | ||
| * Refine your code according to popular style guides | ||
| * Simplify complex functions, break down large classes, and remove redundant code | ||
| * Provide tests to validate that your code is working as expected | ||
|
|
||
| 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). | ||
|
|
||
| ### Update your project's dependencies | ||
|
|
||
| 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). | ||
|
|
||
| ## Looking forward: Maintaining your projects | ||
|
|
||
| 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. | ||
|
|
||
| If you want to improve your profile even more, incorporate these practices into your coding routines: | ||
|
|
||
| * **Maintain a clean commit history**. To make your project history understandable, use descriptive commit messages and work in smaller batches. | ||
| * **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. | ||
| * **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. | ||
| * **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). |
This file contains 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 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.