Skip to content

Commit

Permalink
Merge branch 'open-sauced:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
CBID2 authored Aug 11, 2024
2 parents ee81f7d + 05e9ffb commit d501939
Show file tree
Hide file tree
Showing 73 changed files with 4,602 additions and 939 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
- name: "🔧 setup node"
uses: actions/[email protected]
with:
node-version: 18
node-version: 20

- name: "🔧 install npm@latest"
run: npm i -g npm@latest
Expand Down
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,13 @@
[![Commits](https://img.shields.io/github/commit-activity/w/open-sauced/docs.opensauced.pizza?style=flat)](https://github.com/open-sauced/docs.opensauced.pizza/pulse)
[![Issues](https://img.shields.io/github/issues/open-sauced/docs.opensauced.pizza.svg?style=flat)](https://github.com/open-sauced/docs.opensauced.pizza/issues)
[![Releases](https://img.shields.io/github/v/release/open-sauced/docs.opensauced.pizza.svg?style=flat)](https://github.com/open-sauced/docs.opensauced.pizza/releases)
[![Discord](https://img.shields.io/discord/714698561081704529.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/U2peSNf23P)
[![Twitter](https://img.shields.io/twitter/follow/saucedopen?label=Follow&style=social)](https://twitter.com/saucedopen)
</div>

## 🧪 Built for Experimenting

This tool is meant to accelerate development on [OpenSauced](https://opensauced.pizza) by giving contributors a way to access [Docusaurus 2](https://docusaurus.io/) powered developer documentation available at [docs.opensauced.pizza](https://docs.opensauced.pizza).

## 🤝 Contributing

We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed with your contribution.
We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please check out the [Contributing guide](https://opensauced.pizza/docs/contributing/introduction-to-contributing/) for guidelines about how to proceed with your contribution.

<img align="right" src="https://i.ibb.co/CJfW18H/ship.gif" width="200"/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Maintainers want to help you write your PR; that’s why they often outline cont

![Jerry McGuire “Help me, help you gif”](https://media.giphy.com/media/uRb2p09vY8lEs/giphy.gif)

This file—often called CONTRIBUTING.md—gives guidelines for submitting your PR, including information like whether or not you need to write tests, the communication process, coding style, and how to submit your pull request. Check out [OpenSauced’s Contributing Guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/), as an example.
This file—often called CONTRIBUTING.md—gives guidelines for submitting your PR, including information like whether or not you need to write tests, the communication process, coding style, and how to submit your pull request. Check out [OpenSauced’s Contributing Guide](https://opensauced.pizza/docs/contributing/introduction-to-contributing/), as an example.

## Tips for Your First PR
Although every repository may have unique guidelines, there are general guidelines for all PRs. Here are some tips to keep in mind:
Expand All @@ -41,7 +41,7 @@ A well-written description will help the maintainer understand the purpose of th
3. Helps with future reference. A well-documented PR provides a historical record of the changes made. This helps future team members to understand the evolution of the code and the decisions made along the way. It also helps with future maintenance and debugging.

![OpenSauced's Examples for communication style](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/sc4v1pihnggpq0asu671.png)
<small> OpenSauced’s [CONTRIBUTING guidelines for communication style](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) </small>
<small> OpenSauced’s [CONTRIBUTING guidelines for communication style](https://opensauced.pizza/docs/contributing/introduction-to-contributing/) </small>

### Link the issue
If the PR is related to an issue, you can link that issue and automatically close the issue when the PR is merged. One way to do this is to use this syntax: `closes #issue-number` for example, `closes #11`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If there aren’t any labels for beginners, don’t forget that the [best first

> **Check out [OpenSauced Community Health Files](https://github.com/open-sauced/.github/tree/main).**
- Engage with the Community. Join the project’s communication channels, like Slack or [Discord](https://discord.gg/6KYErCXf), their discussions, their blog, and introduce yourself. Ask questions and express your interest in contributing. Becoming a part of the community will expand your connections, help you to gain insights into ongoing discussions and development timelines, and may be an opportunity for mentorship from experienced contributors.
- Engage with the Community. Join the project’s communication channels, like Slack or Discord, [discussion forum](https://github.com/orgs/open-sauced/discussions), or their blog, and introduce yourself. Ask questions and express your interest in contributing. Becoming a part of the community will expand your connections, help you to gain insights into ongoing discussions and development timelines, and may be an opportunity for mentorship from experienced contributors.
- Start small. Look for issues that are small and easy to fix. As you gain experience, you can start working on larger issues or taking on more responsibility. Don’t be afraid to ask for help or to let the maintainers know if you’ve taken on an issue that you can’t complete. It’s all part of the process.
- Be patient. It takes time to learn how to contribute to an open source project. Don't get discouraged if you don't get everything right the first time. Just keep learning and practicing, and you'll eventually get the hang of it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ Our hope is that the community will provide a safe space to discuss challenges,

5. **Making a Positive Impact**: Your contributions benefit other contributors who rely on these projects, fostering a sense of fulfillment and giving back to the community.

For more information on the challenge, like our upcoming events, including our Intro to Open Source Workshops, check out our [#100DaysOfOSS docs page](https://docs.opensauced.pizza/community/100-days-of-oss/). We'll have more great information and resources there on our launch day to help you on your journey. We'll also be dropping daily prompts on Twitter, so feel free to follow [@saucedopen](https://twitter.com/saucedopen) there for more inspiration.
For more information on the challenge, like our upcoming events, including our Intro to Open Source Workshops, check out our [#100DaysOfOSS docs page](https://opensauced.pizza/docs/community/100-days-of-oss/). We'll have more great information and resources there on our launch day to help you on your journey. We'll also be dropping daily prompts on Twitter, so feel free to follow [@saucedopen](https://twitter.com/saucedopen) there for more inspiration.

If you have any questions or suggestions, feel free to drop them below, so we can continue to work on supporting you in your open source adventure.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Historically, collaborating on code involved manual file sharing or maintaining
2. **Effortless Synchronization**- By cloning repositories, team members can create local copies of the codebase. This means that everyone has their own version to work on and they can use Git to share the changes between repositories.

## Getting Started with Git
If you want to get some hands-on experience using git, check out OpenSauced's [Intro to Open Source Course](https://github.com/open-sauced/intro) or sign-up for one of our workshops that are listed on the bottom of our [#100DaysOfOSS Challenge docs](https://docs.opensauced.pizza/community/100-days-of-oss/).
If you want to get some hands-on experience using git, check out OpenSauced's [Intro to Open Source Course](https://github.com/open-sauced/intro) or sign-up for one of our workshops that are listed on the bottom of our [#100DaysOfOSS Challenge docs](https://opensauced.pizza/docs/community/100-days-of-oss/).

### Remote Repositories and Collaboration
Git allows for collaboration by enabling developers to work on the same codebase from remote locations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You’re more likely to succeed in what you do if you if you set goals and you c

5. **Prioritize and Time Management**. Prioritize your goals and create a schedule that divides time for contributions, learning, and community engagement. Remember, the goal of #100DaysOfOSS is to help you grow. You don’t want to burn out. So be realistic about the time that you have to devote to open source projects. And remember, it’s ok and good to schedule days off as part of your schedule.

6. **Set Accountability Measures**. Establish ways to track your progress, such as using our [journal template](https://github.com/open-sauced/100-days-of-oss-template), adding [a highlight to your OpenSauced profile](https://insights.opensauced.pizza/feed), and/or using the #100DaysOfOSS hashtag on social media. You can also share your goals in the [OpenSauced Discord](https://discord.gg/opensauced) for added support.
6. **Set Accountability Measures**. Establish ways to track your progress, such as using our [journal template](https://github.com/open-sauced/100-days-of-oss-template), adding [a highlight to your OpenSauced profile](https://insights.opensauced.pizza/feed), and/or using the #100DaysOfOSS hashtag on social media. You can also share your goals in the [OpenSauced Community](https://github.com/orgs/open-sauced/discussions) for added support.

7. **Embrace Flexibility**. Stay open to adjusting your goals or setting new ones as you go along with the challenge. You might find there are new opportunities, that you need a break, or that you’re able to spend more time than you initially anticipated.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ If a structured learning experience isn’t for you, you can also find a particu
### The Power of Online Communities

Over the last couple of years, online communities and forums have exploded with opportunity. I’m confident that there is a community that suits your needs out there already (but that doesn’t mean you can’t start your own if you can’t find one!) If you’re not sure where to start OpenSauced offers a lot of different opportunities to be part of a community and ask questions:
- [#100DaysOfOSS](https://docs.opensauced.pizza/community/100-days-of-oss/)
- [OpenSauced Discord](https://discord.gg/opensauced)
- [#100DaysOfOSS](https://opensauced.pizza/docs/community/100-days-of-oss/)
- [OpenSauced Community](https://github.com/orgs/open-sauced/discussions)
- [OpenSauced Twitter + Twitter Spaces](https://twitter.com/saucedopen)

Actively participating in communities allows you to seek guidance, ask questions, and contribute your expertise. While mentors can provide awesome guidance, the traditional 1:1 mentorship model might not be the most effective or accessible option for everyone. Redefining mentorship to include various online resources and interactions can empower you to find your own path to success. Remember, it's not about having a single mentor; it's about building a network of support that uplifts and inspires you on your tech journey.
Loading

0 comments on commit d501939

Please sign in to comment.