Skip to content

Commit

Permalink
feat: start manifesto content, with the what and the why
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagostutz committed May 27, 2020
1 parent 49c87bf commit a31ff17
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
13 changes: 12 additions & 1 deletion MANIFESTO.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# The Poppins Manifesto

Whether you are building a Open Source program in your company or starting your own way on the OSS world, you may notice that it's no that easy to find projects and communities that are focused on mentoring and guiding beginners and "non-natives" on this journey. Open Source is beautiful, but when you are someone with a heavy background on corporate software development or individual freelancing that does all your stuff alone, there's a tough path until you become an effectivelly OSS contributor. Part of this learning path is definitely getting real work done. But how to find real work for beginners in OSS? There are some tips and resources out there and Poppins is one of these.

## What is Poppins?

Poppins is a kind of project managed to help open source **beginners** to level up their skills and increase their experience in a **mentorship** community atmosphere. Poppins projects have a slower development pace and are not focused on making the best software out there, instead it aims to help beginners make their first contributions following a mentor-based learning approach, covering the main aspects of how to build a good OSS in a healthy community.

Projects created with this porpopuse may use the Poppins badge <img src="badge-poppins.svg" alt="Poppins"> to identify them as a good place for beginners to make their first contributions and learn how the OSS development works for real.

## Why Poppins?

## Guidelines to make a Poppins project
Part of the OSS mentoring journey is based on courses, readings and tutorials on how to use Git, GitHub, good practices in open source communities, why OSS is a hot thing in the IT industry and so on. After understanding and learning all this stuff you will face the challenge of making your first contribution. Whether you already know the project you want to contribute or not, you can find lots of resources in the Internet on how to find "Good First Issues". Some of them are outadated, but others are automated resources, like the [GitHub good first issues feature](https://github.blog/2020-01-22-how-we-built-good-first-issues/). But those good first issues resources **can be a step too big in your onboarding** process and maybe it would be smoother if you could contribute on projects that are **"good first projects"** before going to the good first issues.

## Guidelines to make a Poppins project

2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@ This project follow the [Poppins manifesto guidelines](https://github.com/bancod

Here's a list of curated Poppins projects:
- [Poppins](https://github.com/bancodobrasil/poppins): "eat your own dog food", right?
- [First Contributions Repository](https://github.com/firstcontributions/first-contributions)
- [Contribute to this Project](https://github.com/Syknapse/Contribute-To-This-Project): This is for absolute beginners. If you know how to write and edit an anchor tag <a href="" target=""></a> then you should be able to do it.

0 comments on commit a31ff17

Please sign in to comment.