Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (61 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

85 lines (61 loc) · 3.44 KB
Raw

Contributing to Open Dev Path

Thank you for wanting to add more free resources so others can learn and grow. Contributions are welcome.

What we accept

  • Free resources only — courses, tools, bootcamps, certificates, videos, docs, or communities that are free to use (no paywall for core content).
  • Quality over quantity — clear name, working link, and a short description.
  • New categories — if you have a group of resources that don’t fit existing sections, suggest a new category in your PR.

How to add a resource

The list lives in two places. Please update both so the site and README stay in sync.

1. Update README.md

Find the right section (e.g. Coding, Developer Tools, Free Bootcamps, Free Certificates, YouTube Playlists) and add a row to the table:

| [Resource Name](https://example.com) | One short sentence describing what it is and who it’s for. |
  • Keep the same table format (pipe | columns).
  • Put the link on the resource name.
  • Description: one sentence, no marketing fluff.

2. Update index.html

Find the matching category (same name as in the README, e.g. <h3>Coding</h3>). Inside that category’s card-grid, add a new card. Card styles by section:

Section Use this class on the card
Coding card card-teal-dark
Developer Tools card card-teal-dark
Free Bootcamps card card-purple
Free Certificates card card-orange or card card-orange-light
YouTube Playlists card card-yellow or card card-yellow-light
Other Free Resources card card-teal-dark

Icon options:

  • Simple Icons (preferred):
    https://cdn.simpleicons.org/<iconname>
    Icon names: simpleicons.org (e.g. freecodecamp, github, youtube). Add class="card-icon-img natural" if the icon looks better without forced color.
  • Favicon fallback:
    https://www.google.com/s2/favicons?domain=example.com&sz=64
    Use the resource’s domain for domain=.
  • Text fallback:
    Use a <span class="card-icon card-icon-text">AB</span> (e.g. for “CS50”) when there’s no good icon.

Example — new coding resource:

<a href="https://example.com" target="_blank" rel="noopener noreferrer" class="card card-teal-dark">
  <img src="https://cdn.simpleicons.org/example" alt="" class="card-icon-img">
  <h4>Example Resource</h4>
  <p>One short sentence describing what it is.</p>
  <span class="visit-link">Visit</span>
</a>

Add your card in alphabetical order by resource name when possible.

Submitting changes

  1. Fork this repo and clone your fork.
  2. Create a branch:
    git checkout -b add-resource-name
    (e.g. add-resource-name or add-more-youtube-channels).
  3. Edit both README.md and index.html as above.
  4. Commit:
    git add README.md index.html
    git commit -m "Add [Resource Name] to [Category]"
  5. Push to your fork and open a Pull Request against main with a short description of what you added and why it’s useful.

Code of conduct

  • Be respectful and constructive.
  • We reserve the right to reject or edit submissions to keep the list focused and high quality.

Questions?

Open a Discussion or an Issue and we can figure it out.

Thanks for contributing.