Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 4.07 KB

File metadata and controls

94 lines (65 loc) · 4.07 KB

Contributing

Congrats on making it this far! 🎉

If you're reading this, it means you've already taken a big step toward contributing to the project. We're excited to have you here! Contributing to an open source project is a great way to learn, share knowledge, and improve tools that impact a lot of people. Let’s get you started with a few essential steps:

Before you start contributing 🔨

Before jumping in and making your first contributions, it’s important to understand a few core concepts that will make your journey into open source much smoother. These include version control, Git, and GitHub.

This repository is part of a learning journey created by the Cumbuca Dev initiative 💜

It’s based on the book "Git e GitHub para Humanos" (Git and GitHub for Humans), which also accompanies a video-based course called GitHub Essentials.

The material is free and beginner-friendly, but it’s currently only available in Portuguese (PT-BR). If you don’t speak Portuguese, feel free to use any translation tool that works best for you — that’s totally part of the process here.

If these terms are new to you, or if you just want a quick refresher, we recommend checking out the resources below.

We intentionally combine official documentation with beginner-friendly content. Official docs are the source of truth, while our materials focus on making things more accessible — especially for those starting out.

What is Version Control? 📂

Version control is a system that allows developers to track and manage changes to code over time. It ensures that multiple people can work on the same project without overwriting each other’s work. It’s a fundamental part of collaboration in open source projects.

📘 Official documentation:

💜 Beginner-friendly (PT-BR):

What is Git? 🧑‍💻

Git is one of the most popular and widely used version control systems in software development. It helps you manage code changes efficiently and enables teams to collaborate in an organized way.

With Git, you can create branches to work on new features, keep a history of your changes, and easily merge your work back into the main project.

📘 Official documentation:

💜 Beginner-friendly (PT-BR): To dive deeper into Git, we suggest reading chapters 2, 3, and 4 of the Git and GitHub for Humans book:

What is GitHub? 🌐

GitHub is a platform built on top of Git, designed to make it easier to host and manage code repositories. Besides allowing developers to share code publicly or privately, GitHub provides tools that support collaboration, such as issue tracking, pull requests, and automations that improve workflow efficiency.

GitHub is where you’ll create your fork of the project and submit your contributions for review and integration. This is all part of the collaborative workflow.

📘 Official documentation:

💜 Beginner-friendly (PT-BR):

Task 1

Alright, now that you have a solid foundation, let’s move on to your first task!

Actions: