resources.yml

# A list of guides to display on the homepage + readme
# Required Fields:
#   title - the title of the guide (max 60 chars)
#   description - a short description of the guide (max 120 chars)
#   file - filename of the doc must correspond to a file within the /guides directory

# Optional Fields:
#   icon - group and name, find an icon here: https://icones.js.org/
#   color - a hex code but without the hash (#)
#   author - can be set to your name, or GH username if you want to be credited
#   tags - a list of strings that make searching for guides easier
#   index - a number that determines the order of the guides
#   created - date the guide was created, in the format YYYY-MM-DD

guides:
  - title: Why Open Source?
    description: How open source can help you learn and grow as a developer.
    file: why-open-source
    icon: raphael:opensource
    color: 9B5DE5
    index: 0
  
  - title: Submit your first PR (UI)
    description: Learn how to submit your first pull-request via the GitHub UI.
    file: submit-your-first-pr-ui
    icon: fa:github
    color: F15BB5
    index: 1

  - title: Full Local Git Setup
    description: Step-by-step instructions for getting all prerequisites installed.
    file: local-git-setup
    icon: mdi:git
    color: FEE440
    index: 2

  - title: Submit your first PR (CLI)
    description: Learn how to submit your first code change to a project.
    file: submit-your-first-pr-cli
    icon: ion:git-branch
    color: 00BBF9
    index: 3

  - title: Other open source contributions
    description: Not a developer? There's many other ways you can contribute without coding!
    file: other-open-source-contributions
    icon: 'fa:heart'

  - title: Open Source for Businesses
    description: See all the ways embracing open source can benefit your company.
    file: open-source-for-businesses
    icon: ic:round-business-center
    color: 00F5D4
    index: 4

# A list of helpful external resources
resources:
  - title: Simple Introduction to Git
    url: https://rogerdudler.github.io/git-guide/
  - title: Open Source Guides from GitHub
    url: https://opensource.guide/
  - title: Good First Issue - Find beginner-friendly tickets
    url: https://goodfirstissue.dev/
  - title: First Contributions - Find projects to contribute to
    url: https://firstcontributions.github.io/
  - title: Code Triage - Find Projects to Contribute to
    url: https://www.codetriage.com/
  - title: Outreachy - Paid Open Source Internships for Beginners
    url: https://www.outreachy.org/
  - title: Learn Git - Comprehensive yet simple guide from BitBucket
    url: https://www.atlassian.com/git/tutorials/learn-git-with-bitbucket-cloud
  - title: Git Immersion - Quick walk through of Git
    url: https://gitimmersion.com
  - title: Git Tips & Tricks
    url: https://github.com/git-tips/tips
  - title: GitHub Cheatsheet and Hidden Features
    url: https://github.com/tiimgreen/github-cheat-sheet
  - title: Git GUIs for Windows, Mac and Linux
    url: https://git-scm.com/downloads/guis
  - title: All about Git Hooks
    url: https://githooks.com/
  - title: Effective branching patterns of larger teams
    url: https://martinfowler.com/articles/branching-patterns.html
  - title: Choose an open source license
    url: https://choosealicense.com/
  - title: Git Command Explorer
    url: https://gitexplorer.com/
    
# A list of GitHub repositories that are welcoming to first-time contributors
projects:
  - repo: https://github.com/lissy93/git-into-open-source