vijo / community-search

A community-curated repository of 🔥 learning resources

Guidelines for contributing to Athena

Athena is a community-curated repository of 🔥 learning resources. Every resource in this collection is manually curated by the community, and can be searched through here. If you'd like to contribute to Athena, follow this guide, or contribute directly through this Typeform (much simpler, but less cool 🤷‍♂️).

This is where you can contribute your favorite learning resources to the collection! When you do, you get your name on our contributor wall.

Table of Contents

• Why Athena?
• Contributing to this collection
• Updating your Pull Request

Why Athena?

Self-learning with Google, YouTube, and Reddit is difficult because there's so much noise. If you Google "learn programming", half of the results are ads and the other half are products like Codecademy and media companies saying "you should learn how to code." There's a bit of signal, but it's mostly noise. Even if you're serious about self-learning, it's hard to focus and not get caught up in random rabbit holes.

The best way to learn on the Internet is to get people who already know what you're trying to learn about recommend the best resources. This is ideal if you know a subject expert, but if you don't, Athena's the next best thing.

Contributing to this collection

There are three ways to contribute to Athena: through this Github repo, through this Typeform, or through the Intercom chat on the bottom right of our website.

Step-by-step guide to contributing through Github

Step 1. Find a learning resource that's both useful and interesting.
Step 2. Stress-test the resource's quality, by using it yourself.
Step 3. If the resource is 🔥, click on the collection.md file.
Step 4. Now click on the edit icon on the top right (it looks like a pencil).
Step 5. You can start editing the text of the file in the in-browser editor. Make sure you follow the guidelines below. You can use GitHub Flavored Markdown.
Step 6. Scroll down, say why you're proposing the changes, then click on "Propose file change".
Step 7. Finally, submit the pull request!

Please ensure your pull request adheres to the following guidelines:

• Make sure the link is useful before submitting. Athena's value comes from curation, not aggregation.
• Make an individual pull request for each suggestion.
• Follow the template shown in collection.md.
• Make sure your text editor is set to remove trailing whitespace.
• The pull request and commit should have a useful title.

Thank you for your suggestions!

Updating your Pull Request

Here is a write up on how to change a Pull Request, and the different ways you can do that.