Skip to content

Commit

Permalink
feat: start with the difficulties
Browse files Browse the repository at this point in the history
  • Loading branch information
tiagostutz committed May 28, 2020
1 parent b5cec1e commit c476f0f
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
36 changes: 36 additions & 0 deletions MANIFESTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,39 @@ Part of the OSS mentoring journey is based on courses, readings and tutorials on

## Guidelines to make a Poppins project

1. Don't choose critical or "rush scheduled" projects to be a Poppins project. Remeber: the focus of the project is the beginners journey not the release of the software itself.

1. Follow all the guidances of https://opensource.guide/building-community/

1. Put as the first or second item on your README this piece of content:

```
## This project was made for first-time contributors and open source beginners
This project follow the [Poppins manifesto guidelines](https://github.com/bancodobrasil/poppins) as part of it's community principles and policies, focusing all the decisions and interactions on providing open source beginners mentorship with real and relevant experiences, respecting each individual learning pace, background experince, academic formation, questions, suggestions, doubts and opinion.
So, let's start! Open an issue right now asking for a task to be done by you. A mentor/maintainer will come and provide a technical overview of the proejct and what are the possibles ways of contributing to the project. You will discuss the options and a suitable issue will be assigned or created to you.
That's it. Just make yourself at home and good luck!
```

1. Put a list of other [awesome](https://github.com/sindresorhus/awesome) Poppins projects in your README

1. Pin a welcoming issue with instructions on how the users can ask for a task to be done. For example: https://github.com/bancodobrasil/poppins/issues/1

1. Keep the issue notifications enabled for all the mainteners of the project so one of them will quickly come and welcome recent users. When you respond quickly, people will feel they are part of a dialogue, and they’ll be more enthusiastic about participating. Don't let a user more than 48 hours without a response.

1. When a new user creates an issue asking for a task to do, answear him/her with an overview of the project goals, how the tech stack is set, what are the contributing options available and ask him some questions to try to find out what is his technical level so you can write an issue that is perfect for him.

1. Once you created a issue for the user, assign it to him/her and offer any help he/she may need to accomplish the task, whether the struggling being with the code itself, the open source process, the understanding of the problem, lack of documentation and so on. Walk side by side with the user from the day you opened the issue to when the user opens his Pull Request,

1. All the issues created **MUST** be beginner friendly and be labeled as `good first issue`. If you think the issue you are writing is not a good first issue, try to break it into smaller pieces that could be faced as so.

1. Before making your repo public, guarantee that it has enough documentation on how to run and test it so beginners won't struggle to run a "hello world" with it

1. Keep your issues area clean, leaving as opened just the issues that are assigned to first-contributors and are actually being done.

1. Don't run over the project if there is little first-contributors comming. Instead of rush into the development by yourself, head to Twitter, Hackernews, Reddit, LinkedIn and other sort of social platformas and dev communities out there and annouce your project as a harmful place for first-contributors to come.

1. Don't use the issues as a backlog. Keep your backlog in another tool and use it to pick an issue when a first-time contributor arrives and ask for a task to be done.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<br />
<br />
<img height="20" src="badge-poppins.svg" alt="Poppins">
<img src="https://camo.githubusercontent.com/1997c7e760b163a61aba3a2c98f21be8c524be29/68747470733a2f2f617765736f6d652e72652f62616467652e737667" alt="awesome">


## What is Poppins?
Expand All @@ -16,14 +17,18 @@ Projects created with this porpopuse may use the Poppins badge <img src="badge-p

**To build a Poppins project**, follow the [Manifesto Principles and Guidelines](MANIFESTO.md) and have fun. =)

## Open source beginners find help here!
## This project was made for first-time contributors and open source beginners

This project follow the [Poppins manifesto guidelines](https://github.com/bancodobrasil/poppins) as part of it's community principles and policies, focusing all the decisions and interactions on providing open source beginners mentorship with real and relevant experiences, respecting each individual learning pace, background experince, academic formation, questions, suggestions, doubts and opinion.

So, let's start! Open an issue right now asking for a task to be done by you. A mentor/maintainer will come and provide a technical overview of the proejct and what are the possibles ways of contributing to the project. You will discuss the options and a suitable issue will be assigned or created to you.

That's it. Just make yourself at home and good luck!

## Awesome Poppins projects for you to go

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)
- [First Contributions Repository](https://github.com/firstcontributions/first-contributions): Help beginners to contribute to open source projects
- [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 c476f0f

Please sign in to comment.