Skip to content

Commit 51053a5

Browse files
authored
Merge pull request OpenSource-Communities#97 from emontes22/docs-96
docs: Update the 'Formatting Your Highlight' section
2 parents b203217 + e2eedad commit 51053a5

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

06-the-secret-sauce.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ Important information to include when you're highlighting your contributions:
6262

6363
To be most effective in highlighting your contributions, we recommend using the following format:
6464

65-
- **Title**: This should be a short description of the contribution. For example, "Created a GitHub Action to automatically merge pull requests".
66-
- **Link**
6765
- **Description**: When highlighting your contribution, we recommend mentioning the impact that it had on the overall project. This would be helpful in highlighting your qualifications for job positions, especially if you have employment gaps. Consider using the following model to help you craft this highlight into a story:
68-
- Success verb + noun + metric + outcome.
69-
- Example: While I was reviewing some pull requests for this year's GirlScript Summer of Code, I noticed that most of them would not merge in spite of me and the owner giving approvals. So, I **created a GitHub Action where pull requests automatically merge once they have passed the deployment steps(successive verb + noun)**, which **increased productivity rates by 80%(metric + outcome).**
66+
- Success verb + noun + metric + outcome.
67+
- Example: While I was reviewing some pull requests for this year's GirlScript Summer of Code, I noticed that most of them would not merge in spite of me and the owner giving approvals. So, I **created a GitHub Action where pull requests automatically merge once they have passed the deployment steps(successive verb + noun)**, which **increased productivity rates by 80%(metric + outcome).**
68+
- **Add a repo**: Provide the complete name of the repository to which you are making contributions.
69+
- **URL**: Paste the URL to your pull request, issue or your blog post.
7070

7171
![Adding a highlight to your profile](./images/opensauced-highlights.png)
7272

images/opensauced-highlights.png

-1.58 MB
Loading

0 commit comments

Comments
 (0)