Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

Commit

Permalink
feat: reorder chapters (#71)
Browse files Browse the repository at this point in the history
* fix: reorder chapter on README

* fix: delete resources from sidebar

* fix: reorder chapters on sidebar

* feat: add sumarize for each chapter on the README

* fix: create a tip to read chapters in order
  • Loading branch information
adiati98 authored Apr 23, 2024
1 parent dabcd38 commit 85d2dcb
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 9 deletions.
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,43 @@ The course is divided into chapters, with each covering a different aspect of be

### [Intro: Understanding the Role of an Open Source Maintainer](intro.md)

This chapter introduces the role of maintainers in open source, the benefits and the responsibilities of becoming a maintainer, and the challenges they face.

### [How to Setup Your Open Source Project](how-to-setup-your-project.md)

This chapter walks you through the crucial elements necessary for every project to succeed during its initial setup.

### [How to Handle Open Issues and Pull Requests](issues-and-pull-requests.md)

In this chapter, you'll learn how to manage open issues and pull requests in your project, from triaging issues to reviewing pull requests.

### [How to Communicate and Collaborate Effectively](communication-and-collaboration.md)

This chapter will discuss onboarding new contributors, utilizing different communication channels for your open source project's community, and maintaining healthy communication.

### [How to Maintain Code Quality and Documentation](maintaining-code-quality.md)

This chapter covers ways of maintaining code quality and documentation in your open source project.

### [Building and Nurturing a Welcoming and Supportive Community](building-community.md)

In this chapter, you will learn how to build and nurture a welcoming and supportive community in open source, particularly around your project.

### [Maintainer Power Ups](maintainer-powerups.md)

This chapter introduces tools on GitHub that you can utilize to help you save some time, make your work lighter, and boost your productivity as a maintainer.

### [Building Your Open Source Dream Team](your-team.md)

### [Building and Nurturing a Welcoming and Supportive Community](building-community.md)
In this chapter, you'll learn how to create and assemble your team by examining effective collaboration and offering guidance on identifying, onboarding, and empowering your open source squad.

### [How to Communicate and Collaborate Effectively](communication-and-collaboration.md)
### [The Power of Metrics and Analytics](metrics-and-analytics.md)

### [How to Maintain Code Quality and Documentation](maintaining-code-quality.md)
This chapter will help you understand your project's metrics and guide you through understanding, leveraging, and making decisions based on these metrics to create a thriving open source project.

### [Let's Get Practical: Starting Your Project](getting-practical.md)

### [The Power of Metrics and Analytics](metrics-and-analytics.md)
This chapter contains tutorials based on the previous chapters to help you prepare and launch your first open source project as a maintainer.

### Additional Information

Expand All @@ -41,7 +61,9 @@ As this is the beginning of your open source maintainer journey, we've also prov

## Getting Started

To start the course, navigate to the [`intro` file](intro.md) in the repository or visit the [Becoming a Maintainer Course with OpenSauced website](https://maintainer.opensauced.pizza/) and start reading! Each chapter builds on the previous one, so we recommend reading them in order.
To start the course, navigate to the [`intro` file](intro.md) in the repository or visit the [Becoming a Maintainer Course with OpenSauced website](https://maintainer.opensauced.pizza/) and start reading!

?> **Tip:** Each chapter builds on the previous one, so we recommend reading them in order.

As you work through the course, we encourage you to experiment with the tools and concepts covered in the chapters.

Expand Down
8 changes: 4 additions & 4 deletions _layouts/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

- [Open Source Maintainer](intro.md)
- [Setting Up Your Project](how-to-setup-your-project.md)
- [Issues and Pull Requests](issues-and-pull-requests.md)
- [Maintainer Power Ups](maintainer-powerups.md)
- [Setting Up Your Team](your-team.md)
- [Building and Nurturing Community](building-community.md)
- [Managing Issues and Pull Requests](issues-and-pull-requests.md)
- [Effective Communication and Collaboration](communication-and-collaboration.md)
- [Maintaining Code Quality and Documentation](maintaining-code-quality.md)
- [Building and Nurturing Community](building-community.md)
- [Maintainer Power Ups](maintainer-powerups.md)
- [Setting Up Your Team](your-team.md)
- [The Power of Metrics and Analytics](metrics-and-analytics.md)
- [Let's Get Practical](getting-practical.md)
- [Maintainers Guestbook](maintainers-guestbook.md)
Expand Down

0 comments on commit 85d2dcb

Please sign in to comment.