From 4409c6587b41e108a45c4e33b032eb6e60e43690 Mon Sep 17 00:00:00 2001 From: BekahHW <34313413+BekahHW@users.noreply.github.com> Date: Fri, 28 Jun 2024 16:58:48 -0400 Subject: [PATCH] feat: add contrib issue comments (#346) --- docs/contributors/contributors-guide.md | 8 +++++--- docs/welcome/faqs.md | 9 +++++++-- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/contributors/contributors-guide.md b/docs/contributors/contributors-guide.md index ec4076b4..1a561969 100644 --- a/docs/contributors/contributors-guide.md +++ b/docs/contributors/contributors-guide.md @@ -40,10 +40,12 @@ Your profile is a great resource for showcasing your contributions and sharing y ![your profile](../../static/img/profile.png) -On your profile, you will see the "Highlights" tab, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions), and three other tabs: +On your profile, you will see the "Highlights" tab, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions), and two other tabs: + +- **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to. + +Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. There is also an option to view the users latest issue comments. The contributions tab is helpful if you want to showcase a steady and consistent open source contribution experience. -- **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience. -- **Connections**: For pro accounts, you can reach out to other contributors and maintainers to collaborate on projects or to learn from them. - **Recommendations**: This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you're looking for new projects to contribute to. ## Explore: Finding Your Next Open Source Project diff --git a/docs/welcome/faqs.md b/docs/welcome/faqs.md index dc30e04c..ee9ff32c 100644 --- a/docs/welcome/faqs.md +++ b/docs/welcome/faqs.md @@ -15,7 +15,7 @@ keywords: We believe that [good first issues don't exist](https://opensauced.pizza/blog/good-first-issues-dont-exist), and the best way to find an issue to work on is to create the issue yourself. -However, sites like [Good First Issues](https://goodfirstissues.com/) and [First Timers Only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the project search engine you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) to learn more about finding a `good first issue` on GitHub.. +However, sites like [Good First Issues](https://goodfirstissues.com/) and [First Timers Only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the project search engine you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) to learn more about finding a `good first issue` on GitHub. #### Additional Resources: @@ -26,7 +26,12 @@ However, sites like [Good First Issues](https://goodfirstissues.com/) and [First Create a [Repository Insights Page](https://app.opensauced.pizza/hub/insights) or add your merged pull request to a [Highlight](https://app.opensauced.pizza/feed). -### 3. I want to provide feedback on OpenSauced. +### 3. Why does OpenSauced display contributors comments? + +On every OpenSauced user profile, in the contributions tab, we display the Pull Requests and Issues that the user has commented on. This is to give a more comprehensive view of the user's contributions to the open-source community. It also provides insight into the contributor's depth of knowledge, collaboration and communication skills, and provides an additional data point for understanding the user's open-source contributions. + + +### 4. I want to provide feedback on OpenSauced. We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions).