From e2685f5c5ebc0ba40b72f60979875bd775548b8c Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Fri, 16 Jun 2023 21:49:03 -0400 Subject: [PATCH 1/8] [feat] add users docs about highlights --- docs/introduction.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/introduction.md b/docs/introduction.md index 5c27df4c..8a80e893 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -10,3 +10,9 @@ sidebar_label: Introduction to OpenSauced 🍕 [Watch this on YouTube](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s) OpenSauced provides guidance for new contributors finding their next contribution. Our approach towards onboarding offers a way to track contributions through a GitHub powered dashboard. + +## Highlights + +The Highlights feature is what we like to call the "glitzy pepperoni" of your OpenSauced profile. It's the place where you can display your favorite open source contributions whether it's an article you wrote for [Codecademy's Docs website](https://www.codecademy.com/pages/contribute-docs), revising one of the lessons on [freeCodeCamp's curricula](https://contribute.freecodecamp.org/#/index?id=learning-platform), or creating a tutorial for people who use [Audacity](https://support.audacityteam.org/community/contributing/tutorials). + +Eager to get started? Check out[the Effectively Highlights section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more. From 710fcb1d78673993bb22f34462cc3b0d8883a00f Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 18 Jun 2023 00:21:11 -0400 Subject: [PATCH 2/8] fix: revise errors --- docs/contributing/introduction-to-contributing.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index 722e7956..dfaa033c 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -106,6 +106,7 @@ You can also experiment with conventional commits by doing: ```shell npm run push ``` + Using the `npm run push` command is an interactive replacement for `git commit`. It enforces the conventional commits specification for writing commit messages, making it easier for developers and maintainers to understand the changes made in a particular commit. Assuming you are dealing with code changes and you add them using `git add`, once you are ready to commit, there are 2 ways we can proceed: `git commit` or `npm run push`. The second method is preferred, as doing a subsequent `git push` and then opening a PR would ensure the title is conforming to our standards. @@ -117,14 +118,13 @@ GitHub has support for draft pull requests, which will disable the merge button ## Issues If you wish to work on an open issue, please comment on the issue with `.take` and it will be assigned to you. If an issue is not assigned, it is assumed to be open for anyone to work on. Please assign yourself to an issue before beginning work on it to avoid conflicts. - + If you are contributing to the project for the first time, please consider checking the [bug](https://github.com/open-sauced/hot/issues?q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+bug%22) or [good first issue](https://github.com/open-sauced/hot/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) labels. In case you get stuck, please feel free to ask for help in the [Discord](https://discord.gg/U2peSNf23P) server or GitHub Discussions. Please note that we have a [code of conduct](./code-of-conduct.md), please follow it in all your interactions with the project and it's contributors. - ## Triage team The Triage team is inspired by [expressjs/express](https://github.com/expressjs/express/blob/HEAD/Triager-Guide.md). This team exists to create a path for making contributions to this project and open source. All Triage Team members are expected to follow this guide: [TRIAGE_GUIDE.md](./triage-guide.md) @@ -135,7 +135,7 @@ For those interested in getting involved in the project or just open source in g ## Funding -OpenSauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the projectd directly or indirectly, please consider adding your profile to the [FUNDING.yml](https://github.com/open-sauced/.github/blob/main/FUNDING.yml). +OpenSauced is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://github.com/sponsors/open-sauced) for details on how funds are distributed. If you have made any contributions to the project directly or indirectly, please consider adding your profile to the [FUNDING.yml](https://github.com/open-sauced/.github/blob/main/FUNDING.yml). ## Community From 5dbba4fa8ac7049c1b43ce245cf0694e64094f4d Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 18 Jun 2023 14:42:31 -0400 Subject: [PATCH 3/8] rearrange sections --- docs/introduction.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/introduction.md b/docs/introduction.md index 8a80e893..832caaa3 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -16,3 +16,23 @@ OpenSauced provides guidance for new contributors finding their next contributio The Highlights feature is what we like to call the "glitzy pepperoni" of your OpenSauced profile. It's the place where you can display your favorite open source contributions whether it's an article you wrote for [Codecademy's Docs website](https://www.codecademy.com/pages/contribute-docs), revising one of the lessons on [freeCodeCamp's curricula](https://contribute.freecodecamp.org/#/index?id=learning-platform), or creating a tutorial for people who use [Audacity](https://support.audacityteam.org/community/contributing/tutorials). Eager to get started? Check out[the Effectively Highlights section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more. + +## Insights + +- Add information about Highlights here + +## Collaborations (Soon) + +- TBA + +## FAQs + +- Add information about FAQs here + +## Community + +- Add information about the community here + +## Contributing + +- Ready to start contributing? Start here. From 9f32ba3984f487cd32f60cb00fe8a4c7f74be8af Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 18 Jun 2023 14:52:20 -0400 Subject: [PATCH 4/8] [fix]: revise changes --- docs/introduction.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/introduction.md b/docs/introduction.md index 832caaa3..cdb65ac8 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -19,7 +19,7 @@ Eager to get started? Check out[the Effectively Highlights section in our free " ## Insights -- Add information about Highlights here +- Add information about Highlights here. ## Collaborations (Soon) @@ -27,11 +27,11 @@ Eager to get started? Check out[the Effectively Highlights section in our free " ## FAQs -- Add information about FAQs here +- Add information about FAQs here. ## Community -- Add information about the community here +- Add information about the community here. ## Contributing From 2ef455b6fb04de2e06aca601b9053b7b73e2e9aa Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 18 Jun 2023 15:09:07 -0400 Subject: [PATCH 5/8] fix: revise Contributing Section --- introduction.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 introduction.md diff --git a/introduction.md b/introduction.md new file mode 100644 index 00000000..e69de29b From 639f48cd525a3b037fef98a3e0fa98c10df86219 Mon Sep 17 00:00:00 2001 From: Christine Belzie Date: Sun, 18 Jun 2023 15:20:22 -0400 Subject: [PATCH 6/8] fix: revise Markdown errors --- docs/community/welcome-to-the-community.md | 9 ++++++--- docs/introduction.md | 2 -- welcome-to-the-community.md | 0 3 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 welcome-to-the-community.md diff --git a/docs/community/welcome-to-the-community.md b/docs/community/welcome-to-the-community.md index f3a88dbb..408e4fb8 100644 --- a/docs/community/welcome-to-the-community.md +++ b/docs/community/welcome-to-the-community.md @@ -6,12 +6,14 @@ keywords: - welcome to the community --- -## The OpenSauced Community +## The OpenSauced Community Welcome to the OpenSauced community! At OpenSauced, we're striving to bring collaboration and inspiration to every open source contributor and to help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open. ### Community Guidelines + At OpenSauced, we strive to create a welcoming and inclusive community for everyone. We have a few guidelines to help us achieve this goal: + - Be respectful and kind to others in the community. - Be patient with others and help them learn. - Be open to feedback and constructive criticism. @@ -30,6 +32,7 @@ The OpenSauced community is a group of open-source enthusiasts who are passionat - 📰 Subscribe to our [newsletter](https://news.opensauced.pizza/#/portal/signup) for all things OpenSauced and open source. ## How can I get involved? + You can get involved in the OpenSauced community in a few ways: - Share your Contributions! We love to see what you're working on. Highlight your contributions on [OpenSauced](https://insights.opensauced.pizza/feed). @@ -37,6 +40,6 @@ You can get involved in the OpenSauced community in a few ways: - Share what you're working on, ask questions, or mentor new contributors in our [Discord](https://discord.gg/opensauced). ## Resources on Getting Started with Open Source -- 📝 Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors. -- 📖 Take our [Intro to Open Source Course](https://github.com/open-sauced/intro) to help you get started with open-source. +- 📝 Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors. +- 📖 Take our [Intro to Open Source Course](https://github.com/open-sauced/intro) to help you get started with open-source. diff --git a/docs/introduction.md b/docs/introduction.md index f882aecd..cdb65ac8 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -36,5 +36,3 @@ Eager to get started? Check out[the Effectively Highlights section in our free " ## Contributing - Ready to start contributing? Start here. -Eager to get started? Check out [the Effectively Highlights section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more. - diff --git a/welcome-to-the-community.md b/welcome-to-the-community.md new file mode 100644 index 00000000..e69de29b From 5e52d59cfcc58a353e07f7caf7c0b2204a914597 Mon Sep 17 00:00:00 2001 From: Christine Belzie <105683440+CBID2@users.noreply.github.com> Date: Mon, 19 Jun 2023 18:24:09 -0400 Subject: [PATCH 7/8] fix: wrote the full title --- docs/introduction.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/introduction.md b/docs/introduction.md index cdb65ac8..599111ea 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -9,13 +9,13 @@ sidebar_label: Introduction to OpenSauced 🍕 [Watch this on YouTube](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s) -OpenSauced provides guidance for new contributors finding their next contribution. Our approach towards onboarding offers a way to track contributions through a GitHub powered dashboard. +OpenSauced provides guidance for new contributors to find their next contribution. Our approach towards onboarding offers a way to track contributions through a GitHub-powered dashboard. ## Highlights The Highlights feature is what we like to call the "glitzy pepperoni" of your OpenSauced profile. It's the place where you can display your favorite open source contributions whether it's an article you wrote for [Codecademy's Docs website](https://www.codecademy.com/pages/contribute-docs), revising one of the lessons on [freeCodeCamp's curricula](https://contribute.freecodecamp.org/#/index?id=learning-platform), or creating a tutorial for people who use [Audacity](https://support.audacityteam.org/community/contributing/tutorials). -Eager to get started? Check out[the Effectively Highlights section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more. +Eager to get started? Check out[the Effectively Highlights Your Contributions section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more. ## Insights From cedbb690f495660c21a261e700c5bf60d34dd07a Mon Sep 17 00:00:00 2001 From: Brian Douglas Date: Mon, 3 Jul 2023 07:59:12 -0700 Subject: [PATCH 8/8] remove extra TBD sections --- docs/introduction.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs/introduction.md b/docs/introduction.md index 599111ea..b40faf6a 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -16,23 +16,4 @@ OpenSauced provides guidance for new contributors to find their next contributio The Highlights feature is what we like to call the "glitzy pepperoni" of your OpenSauced profile. It's the place where you can display your favorite open source contributions whether it's an article you wrote for [Codecademy's Docs website](https://www.codecademy.com/pages/contribute-docs), revising one of the lessons on [freeCodeCamp's curricula](https://contribute.freecodecamp.org/#/index?id=learning-platform), or creating a tutorial for people who use [Audacity](https://support.audacityteam.org/community/contributing/tutorials). Eager to get started? Check out[the Effectively Highlights Your Contributions section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more. - -## Insights - -- Add information about Highlights here. - -## Collaborations (Soon) - -- TBA - -## FAQs - -- Add information about FAQs here. - -## Community - -- Add information about the community here. - -## Contributing - - Ready to start contributing? Start here.