Skip to content

Commit

Permalink
markdownlint for all pertinent issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@ShaneCurcuru
ShaneCurcuru committed Dec 10, 2023
1 parent dc33ef4 commit 19e9b54
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions index.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
layout: index
---
### Welcome! Let's do some open source!

# Welcome! Let's do some open source!

Contributing to open source for the first time can be scary and a little overwhelming. Perhaps you're a [Code Newbie](https://www.codenewbie.org) or maybe you've been coding for a while but haven't found a project you felt comfortable contributing to.

## You can do it! Here's how.

### You can do it! Here's how.
If you have never contributed to an open source project before and you're just getting started, consider exploring these resources.

* [First contributions](https://github.com/firstcontributions/first-contributions) is a hands-on tutorial that walks you through contributions workflow on GitHub. When you complete the tutorial, you have made a contribution to the same project.
* [First contributions](https://github.com/firstcontributions/first-contributions#first-contributions) is a hands-on tutorial that walks you through contributions workflow on GitHub. When you complete the tutorial, you have made a contribution to the same project.
* [https://up-for-grabs.net](https://up-for-grabs.net) is a site that aggregates (rolls up and makes easy to explore) projects that actively *want* help. They label those projects with things like "up-for-grabs", "jump-in" or "help wanted."
* [goodfirstissues.com](https://goodfirstissues.com) is a site that aggregates *the latest issues* with the label "Good First Issue", which is a GitHub feature for finding easy issues to tackle (see [how it was built](https://github.blog/2020-01-22-how-we-built-good-first-issues/)). *goodfirstissues.com* empowers first-time contributors to find and select issues that they want to solve.
* [goodfirstissue.dev](https://goodfirstissue.dev/) curates easy pickings from popular open-source projects, and helps you make your first contribution to open-source.
Expand All @@ -18,7 +20,7 @@ If you have never contributed to an open source project before and you're just g
* Wondering what someone else's first contribution was? You can easily find out any GitHub usernames "[First Pull Request](https://firstpr.me/)" here! (I think you'll find that most people's first PRs were relatively small [like Kent's](https://firstpr.me/#kentcdodds)).
* We think that open source projects [should value civility, kindness, and patience with new developers](https://www.hanselman.com/blog/bring-kindness-back-to-open-source). We encourage you to explore projects that have a published [Code of Conduct](https://www.contributor-covenant.org/).

### Yes, it's scary. But SO rewarding!
## Yes, it's scary. But SO rewarding!

We asked folks on Twitter what they felt when they made their first contribution to an open source project. Here are just a few of their tweets.

Expand All @@ -36,14 +38,14 @@ Some had bad experiences. The purpose of `first-timers-only` is to help everyone

<blockquote class="twitter-tweet" data-conversation="none" lang="en"><p lang="en" dir="ltr"><a href="https://twitter.com/shanselman">@shanselman</a> Can&#39;t remember the project, but it felt hostile, because I didn&#39;t know the contribution rules of the project, and got remarks.</p>&mdash; Bart Verkoeijen (@bgever) <a href="https://twitter.com/bgever/status/630598265365401601">August 10, 2015</a></blockquote>

### Are you an OSS Project Owner?
## Are you an OSS Project Owner?

If you are an OSS project owner, then consider marking a few open issues with the label [first-timers-only](https://github.com/search?q=label%3Afirst-timers-only&state=open&type=Issues). The `first-timers-only` label explicitly announces:

> I'm willing to hold your hand so you can make your first PR. This issue is a bit easier than normal.
> And anyone who's already contributed to open source isn't allowed to touch this one!
First timer contributions are normally very small and easy. One [recent `first-timers-only`](https://github.com/formly-js/angular-formly/pull/415/files) issue was literally three lines of simple changes! And the changes were [described in great detail](https://github.com/formly-js/angular-formly/issues/410#issuecomment-127227984) and tested by the project maintainer. But this makes it easier for the contributor to _get the hang of the contribution process rather than the contribution itself._ Remember, this isn't as much about getting your project features implemented quickly as it is about helping first timers.
First timer contributions are normally very small and easy. One [recent `first-timers-only`](https://github.com/formly-js/angular-formly/pull/415/files) issue was literally three lines of simple changes! And the changes were [described in great detail](https://github.com/formly-js/angular-formly/issues/410#issuecomment-127227984) and tested by the project maintainer. But this makes it easier for the contributor to *get the hang of the contribution process rather than the contribution itself.* Remember, this isn't as much about getting your project features implemented quickly as it is about helping first timers.

Why is YAL (yet another label) like `first-timers-only` important? Because it makes a statement that first timers are welcome, that they are valued, and that they can start contributing to your project! Often [the hard part of getting into open source for the first time isn’t the implementation of a feature, but figuring out how to actually contribute code](https://kentcdodds.com/blog/first-timers-only) such that the pull request is accepted! But, oh the feeling of accomplishment when your first PR is merged!

Expand All @@ -52,17 +54,19 @@ Go label an issue or two with `first-timers-only` and *advertise* that those iss
[![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg?style=flat-square)](https://www.firsttimersonly.com/)

You can use this markdown snippet to add the badge:

```markdown
[![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blue.svg?style=flat-square)](https://www.firsttimersonly.com/)
```

[Kent C. Dodds](https://twitter.com/kentcdodds) proposed [First Timers Only](https://kentcdodds.com/blog/first-timers-only) to get new people to make their first contribution. [Scott Hanselman](https://www.hanselman.com/) blogged about [Bringing Kindness Back to Open Source](https://www.hanselman.com/blog/BringKindnessBackToOpenSource.aspx), so it was obvious that we team up and promote these ideas and get more folks involved in open source.
[Kent C. Dodds](https://twitter.com/kentcdodds) proposed [First Timers Only](https://kentcdodds.com/blog/first-timers-only) to get new people to make their first contribution. [Scott Hanselman](https://www.hanselman.com/) blogged about [Bringing Kindness Back to Open Source](https://www.hanselman.com/blog/BringKindnessBackToOpenSource.aspx), so it was obvious that we team up and promote these ideas and get more folks involved in open source.

[Utkarsh Upadhyay](https://twitter.com/musically_ut) created a bot called [@first_tmrs_only](https://twitter.com/first_tmrs_only) which tweets when a new first-timers-only issue is posted on GitHub. Follow it to stay abreast with latest first-timers-only issues!

[Angie Gonzalez](https://agonzalez0515.github.io/) and [Arlene Perez](https://github.com/techforchange) created a GitHub app called [First Timers](https://github.com/apps/first-timers) that automates most of the process of creating `first-timers-only` issues. Install the app on your repositories and commit simple changes to branches with names starting with `first-timers-` – the First Timers App will turn it into a fully fledged issue with all information a first-time Open Source contributor will need to make their first pull request.

### Empower a First Timer today!
We believe - and we hope you do too - that learning how to code, how to think, *and* _how to contribute to open source_ can empower the next generation of coders and creators. We VALUE first time contributors and we want them to know that everyone started somewhere! Start here!
## Empower a First Timer today!

We believe - and we hope you do too - that learning how to code, how to think, *and* *how to contribute to open source* can empower the next generation of coders and creators. We VALUE first time contributors and we want them to know that everyone started somewhere! Start here!

<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>

0 comments on commit 19e9b54

Please sign in to comment.