You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,18 +52,18 @@ Running the project locally is essential to see your changes in real-time and te
52
52
53
53
We recommend one of these two methods for running the project on your local machine:
54
54
55
-
1. Using the [Docsify CLI](https://docsify.js.org/#/).
55
+
1. Using the [docsify CLI](https://docsify.js.org/#/).
56
56
2. Leveraging Visual Studio Code's [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) extension.
57
57
58
-
#### Method 1: Using the Docsify CLI
58
+
#### Method 1: Using the docsify CLI
59
59
60
60
1.**Install Node.js**.
61
61
62
62
You can download it from the official [Node.js website](https://nodejs.org/).
63
63
64
-
2.**Install Docsify globally**.
64
+
2.**Install docsify globally**.
65
65
66
-
It's highly recommended to install Docsify globally. In your terminal, run the following command:
66
+
It's highly recommended to install docsify globally. In your terminal, run the following command:
67
67
68
68
```bash
69
69
npm install -g docsify-cli
@@ -120,11 +120,11 @@ Live Server extension allows you to launch a local development server and previe
120
120
121
121
## Working with the Content
122
122
123
-
The contents of this course are written in [Markdown](https://www.markdownguide.org/). Please read the [Using Markdown for This Project](#using-markdown-for-this-project) section for details about how to use Markdown in this project.
123
+
The contents of this course are written in [Markdown](https://www.markdownguide.org/). Please read the "[Using Markdown for This Project](#using-markdown-for-this-project)" section for details about how to use Markdown in this project.
124
124
125
125
### Adding Definitions to the Glossary
126
126
127
-
If you add definitions to the [Glossary](../intro-to-oss/glossary.md) chapter, ensure the definitions are added in **alphabetical order**.
127
+
If you add definitions to the "[Glossary](./intro-to-oss/glossary.md)" chapter, ensure the definitions are added in **alphabetical order**.
128
128
129
129
### Adding a New Section to a Chapter
130
130
@@ -249,7 +249,7 @@ Create links using square brackets (`[]`) for the link text and parentheses (`()
249
249
Embed images using an exclamation mark (`!`), followed by square brackets (`[]`) for the alt text, and parentheses (`()`) for the image URL.

253
253
```
254
254
255
255
#### 6. Blockquotes
@@ -280,4 +280,4 @@ git pull
280
280
281
281
## Translating the Intro to Open Source Course
282
282
283
-
Translating our Intro to Open Source course helps make it more accessible to a broader audience. If you're interested in translating this course, please read our [🌐 i18n Guidelines](/i18n-guidelines.md) page.
283
+
Translating our Intro to Open Source course helps make it more accessible to a broader audience. If you're interested in translating this course, please read our [🌐 i18n Guidelines](i18n-guidelines.md) page.
Copy file name to clipboardExpand all lines: docs/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,17 +15,17 @@ At OpenSauced, we aim to empower contributors, maintainers, and teams in open so
15
15
16
16
This course is designed to equip you with the skills and knowledge you need to contribute to open source projects. It offers engaging exercises to help you begin your journey towards becoming a successful contributor, and even provides an opportunity to get your first pull request merged.
17
17
18
-
**Head to our [Intro to Open Source](./intro-to-oss/) course to start your learning journey!**
18
+
**Head to our [Intro to Open Source](./intro-to-oss/README.md) course to start your learning journey!**
19
19
20
20
### Becoming a Maintainer — Coming Soon!
21
21
22
22
This course is designed to aid people who are interested in becoming open source project maintainers. It guides you through maintainers' best practices and provides resources and tools that help maintainers perform their tasks. This course is equipped with a tutorial for you to get practical.
23
23
24
24
## **Contributing to Our Courses**
25
25
26
-
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 Guidelines](/CONTRIBUTING.md) for information on how to contribute.
26
+
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 Guidelines](CONTRIBUTING.md) for information on how to contribute.
27
27
28
-
If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](/i18n-guidelines.md).
28
+
If you want to translate our Intro to Open Source course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).
@@ -25,7 +25,7 @@ Official translations start as a post on our [GitHub Discussions](https://github
25
25
26
26
#### 2. Community Translations
27
27
28
-
We can't always support the maintenance of translations. However, we know some contributors are willing to translate, and we value these contributions. For that reason, we have a [Community Translations](./community-translations.md) section.
28
+
We can't always support the maintenance of translations. However, we know some contributors are willing to translate, and we value these contributions. For that reason, we have a [Community Translations](community-translations.md) section.
29
29
30
30
If you're interested in translating our Intro to Open Source course, fork this repository and add the translation to your forked repository. Then, you can add a link to your translation in the `community-translations.md` file that you can find in the root directory.
31
31
@@ -37,7 +37,7 @@ If you are familiar with the translated language(s), you can help us review the
37
37
38
38
## Adding Translations
39
39
40
-
First, please read our [Contributing Guide](./CONTRIBUTING.md) to setting up the project locally and for the technical instruction. Then, follow these steps to add the translations:
40
+
First, please read our [Contributing Guide](CONTRIBUTING.md) to setting up the project locally and for the technical instruction. Then, follow these steps to add the translations:
Copy file name to clipboardExpand all lines: docs/intro-to-oss/README.md
+16-10Lines changed: 16 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,48 +20,54 @@ For translations in other languages that are maintained by our community, please
20
20
21
21
The course is divided into chapters, each covering a different aspect of open source:
22
22
23
-
### What is Open Source?
23
+
### [Intro](intro.md)
24
+
25
+
This chapter sets the stage for your open source journey and discusses prerequisites, objectives, and expectations.
26
+
27
+
### [What is Open Source?](what-is-open-source.md)
24
28
25
29
This chapter provides an introduction to open source, its history, and its importance in today's software development landscape.
26
30
27
-
### Why Open Source?
31
+
### [Why Open Source?](why-open-source.md)
28
32
29
33
In this chapter, you'll learn about the benefits of open source software, such as increased collaboration, faster development, and improved quality.
30
34
31
-
### Tools to be Successful
35
+
### [Tools to be Successful](tools-to-be-successful.md)
32
36
33
37
Discover the key tools and platforms necessary for a successful journey in open source development. From Git and GitHub for version control and collaboration to CodeSee for code visualization and VS Code as your code editor, this chapter provides an overview of how to leverage these essential tools.
34
38
35
-
### How to Contribute to Open Source
39
+
### [How to Contribute to Open Source](how-to-contribute-to-open-source.md)
36
40
37
41
This chapter covers finding projects to work on, submitting contributions, onboarding contributors to new projects, and the outcomes after submitting contributions. Tips for finding projects include browsing GitHub and GitLab, following personal interests, joining open source communities, and utilizing platforms like OpenSauced.
38
42
39
-
### The Secret Sauce
43
+
### [The Secret Sauce](the-secret-sauce.md)
40
44
41
45
This chapter focuses on providing lesser-known strategies and tips for making a lasting impact in the open source community. This chapter provides strategies for finding issues, gaining traction in your open source journey, and leveraging OpenSauced to build your open source resume.
42
46
43
-
### Types of Contributions
47
+
### [Types of Open Source Contributions](types-of-contributions.md)
44
48
45
49
This chapter explains the non-coding and coding types of contributions involved with open source projects.
46
50
47
51
### Additional Information
48
52
49
53
As this is the beginning of your open source journey, we've also provided additional information in these chapters:
50
54
51
-
-[Glossary](./glossary.md): A glossary of common terms and definitions used in open source.
52
-
-[Additional Resources](./additional-resources.md): A list of resources for further learning about open source, including blog posts, tutorials, and guides.
55
+
-[Glossary](glossary.md): A glossary of common terms and definitions used in open source.
56
+
-[Additional Resources](additional-resources.md): A list of resources for further learning about open source, including blog posts, tutorials, and guides.
53
57
54
58
## Getting Started
55
59
56
-
To start the course, navigate to the [`intro` file](/intro-to-oss/intro.md) in the repository or visit the [Intro to Open Source with OpenSauced website](https://intro.opensauced.pizza/) and start reading! Each chapter builds on the previous one, so we recommend reading them in order.
60
+
If you are taking this course on our GitHub repository, navigate to the [`intro.md` file](intro.md) to start the course. Alternatively, visit the [Intro to Open Source with OpenSauced on the website](https://intro.opensauced.pizza/#/intro-to-oss/) and start reading!
61
+
62
+
Each chapter builds on the previous one, so we recommend reading them in order.
57
63
58
64
As you work through the course, we encourage you to experiment with the tools and concepts covered in each chapter. The best way to learn is by doing, so try contributing to an open source project or building your project from scratch!
59
65
60
66
## Building Your Open Source Resume
61
67
62
68
One of the unique features of this course is that it guides you to build your open source resume using OpenSauced. OpenSauced is a platform that helps you track and showcase your open source contributions, making it easier to get noticed by potential employers and collaborators.
63
69
64
-
To learn more about using OpenSauced to build your open source resume, check out the [Building Your Open Source Resume](/intro-to-oss/the-secret-sauce.md#building-your-open-source-resume) section in [The Secret Sauce](/intro-to-oss/the-secret-sauce.md) chapter.
70
+
To learn more about using OpenSauced to build your open source resume, check out the "[Building Your Open Source Resume](the-secret-sauce.md#building-your-open-source-resume)" section in "The Secret Sauce" chapter.
Copy file name to clipboardExpand all lines: docs/intro-to-oss/conclusion.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,21 @@ As we wrap up this course on getting started with open source, let's recap the k
6
6
7
7
Throughout this course, we've covered a range of topics designed to help you understand and navigate the world of open source:
8
8
9
-
1.**What is open source?**: We discussed the definition of open source, its history, and the core principles that guide the open source movement.
9
+
-**[What is Open Source?](what-is-open-source.md)**: We discussed the definition of open source, its history, and the core principles that guide the open source movement.
10
10
11
-
2.**Why open source?**: We explored the benefits of engaging with open source projects, including access to knowledge, community, and skills development.
11
+
-**[Why Open Source?](why-open-source.md)**: We explored the benefits of engaging with open source projects, including access to knowledge, community, and skills development.
12
12
13
-
3.**Tools to be successful**: We introduced essential tools and platforms for open source contributors, such as GitHub, Git, CodeSee, Visual Studio Code, and Discord.
13
+
-**[Tools to be Successful](tools-to-be-successful.md)**: We introduced essential tools and platforms for open source contributors, such as GitHub, Git, CodeSee, Visual Studio Code, and Discord.
14
14
15
-
4.**How to contribute to open source**: We discussed the process of finding projects to work on, submitting contributions, onboarding to new projects, and what happens after your contribution is submitted.
15
+
-**[How to Contribute to Open Source](how-to-contribute-to-open-source.md)**: We discussed the process of finding projects to work on, submitting contributions, onboarding to new projects, and what happens after your contribution is submitted.
16
16
17
-
5.**The Secret Sauce**: We shared strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
17
+
-**[The Secret Sauce](the-secret-sauce.md)**: We shared strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
18
+
19
+
-**[Types of Open Source Contributions](types-of-contributions.md)**: We shared the coding and non-coding types of contributions in open source, along with examples.
18
20
19
21
By understanding these concepts and applying the strategies we've discussed, you'll be well-equipped to embark on a successful open source journey.
20
22
21
-
## What's next?
23
+
## What's Next?
22
24
23
25
With the knowledge and tools you've gained from this course, you're ready to dive into the world of open source and start making meaningful contributions. Here are some next steps to help you continue your open source journey:
24
26
@@ -34,7 +36,7 @@ With the knowledge and tools you've gained from this course, you're ready to div
34
36
35
37
6.**Share your experiences**: Document your open source journey by writing blog posts, creating tutorials, or giving presentations. This will not only help others learn from your experiences but also establish you as a thought leader in the open source community.
36
38
37
-
7.**Continue learning**: Open source is a dynamic and ever-evolving field. Stay current with the latest tools, techniques, and best practices by attending workshops, taking online courses, and reading articles and books on open source development. We've included an [additional resources section](./additional-resources.md) for more information.
39
+
7.**Continue learning**: Open source is a dynamic and ever-evolving field. Stay current with the latest tools, techniques, and best practices by attending workshops, taking online courses, and reading articles and books on open source development. We've included an [additional resources section](additional-resources.md) for more information.
38
40
39
41
In conclusion, embarking on an open source journey is a rewarding and enriching experience that can help you develop new skills, connect with like-minded individuals, and make a lasting impact on the projects you work on. With the knowledge and tools you've gained from this course, you're well-prepared to take on the exciting challenges and opportunities that await you in the open source world. So go forth and start contributing – the open source community eagerly awaits your participation!
Copy file name to clipboardExpand all lines: docs/intro-to-oss/how-to-contribute-to-open-source.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -177,7 +177,7 @@ You'll need to have these tools donwloaded and installed on your local machine:
177
177
178
178
Congratulations on your first contribution! 🎉
179
179
180
-
?> If you're ready for your next contribution, head on over to the [pizza-verse repo](https://github.com/open-sauced/pizza-verse) and follow the contribution guidelines for your next contribution. Once you're done, head on over to "[The Secret Sauce](./the-secret-sauce.md)" chapter in this course.
180
+
?> If you're ready for your next contribution, check out the [pizza-verse repository](https://github.com/open-sauced/pizza-verse) and follow the contribution guidelines.
181
181
182
182
## Keeping Branches Up to Date
183
183
@@ -283,7 +283,7 @@ Before resolving merge conflicts, you must first [update your branches](#updatin
283
283
284
284
<hr>
285
285
286
-
As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the next chapter, we'll discuss some strategies for getting started with open source contributions, gaining traction in your contributions, and developing your open source resume using OpenSauced.
286
+
As you continue to contribute to open source projects, you'll gain valuable experience, develop new skills, and build a strong portfolio of work. In the [next chapter](the-secret-sauce.md), we'll discuss some strategies forgetting started with open source contributions, gaining tractionin your contributions, and developing your open source resume using OpenSauced.
287
287
288
288
<footer>
289
289
<a href="https://github.com/open-sauced/intro/blob/main/docs/intro-to-oss/how-to-contribute-to-open-source.md">✏️ Edit this page</a>
0 commit comments