diff --git a/README.md b/README.md index 1e5d044..2bbf29e 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,70 @@ ![DISC logo](./assets/DISC.png) -# Overcoming barriers to entry in Open Source projects +# Overcoming Barriers to Entry in Open Source Projects -This repository contains documents and resources on getting started with Open -Source projects. +This repository contains documents and resources to help newcomers get started +with Open Source projects and communities. -This resource was created as part of the [NumFOCUS DISC Unconference](https://pydata.org/nyc2017/diversity-inclusion/disc-unconference-2017/). 📃 Read about its creation on the [NumFOCUS blog](https://numfocus.org/blog/getting-started-open-source-notes-numfocus-disc-unconference). +This resource was created as part of the +[NumFOCUS DISC Unconference](https://pydata.org/nyc2017/diversity-inclusion/disc-unconference-2017/). +You can read more about its creation on the +[NumFOCUS blog](https://numfocus.org/blog/getting-started-open-source-notes-numfocus-disc-unconference). -### [Why contribute to Open Source?](./what_is_open_source_and_why_contribute.md) -Wondering why you contribute to Open Source? Here are a few good reasons it can benefit both you and the world! +--- -### [Compilation of Open Source Resources](./compilation_of_open_source_resources.md) -This file includes a collection of external resources (links) that elaborate on how to contribute to Open Source projects effectively as a newbie. +## Why Contribute to Open Source? -### [How to organize an Open Source sprint](./how_to_organize_an_open_source_sprint.md) -An Open Source sprint is a short event where groups of people get together to work on a single Open Source project with help from its maintainers. We provide detailed instructions and resources for organizing an Open Source sprint at your company, club or Meetup Group. +Curious about why people contribute to Open Source? +This document explains how contributing can benefit both you and the broader +community. +👉 [Why contribute to Open Source?](./what_is_open_source_and_why_contribute.md) -### [Meet the Contributors](./open_source_stories.md) -About the contributors to this repo and their Open Source experience. +--- + +## Compilation of Open Source Resources + +A curated list of external resources and guides to help beginners understand +how to contribute effectively to Open Source projects. + +👉 [Compilation of Open Source Resources](./compilation_of_open_source_resources.md) + +--- + +## How to Organize an Open Source Sprint + +An Open Source sprint is a short, focused event where contributors collaborate +on a single Open Source project, often with guidance from maintainers. +This guide provides step-by-step instructions and best practices. + +👉 [How to Organize an Open Source Sprint](./how_to_organize_an_open_source_sprint.md) + +--- + +## Meet the Contributors + +Learn about the contributors to this repository and their Open Source journeys. + +👉 [Meet the Contributors](./open_source_stories.md) + +--- + +## Getting Started for First-Time Contributors + +This section is intended for beginners who are making their **first Open Source +contribution**, including participants from programs like GSoC, Hacktoberfest, +and NumFOCUS events. + +--- + +### 1. Install Git + +Git is required to contribute to this project. + +Download Git from the official website: +https://git-scm.com/downloads + +After installation, verify that Git is available by running: + +```bash +git --version