GH-900-Files

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 16 Open GitHub ↗

Files supporting the course GitHub Foundations (GH-900)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GH-900 Course Files

Welcome to the **GitHub Foundations (GH-900)** course resource repository! This repository contains helpful files, templates, guides, and reference materials to support your learning journey with Git and GitHub.

## 📚 What's Inside

This repository is organized to provide easy access to various resources:

- **Cheat Sheets** - Quick reference guides for Git and GitHub commands
- **Templates** - Ready-to-use templates for .gitignore, README, and GitHub files
- **Workflows** - Example GitHub Actions workflows for CI/CD
- **Guides** - Comprehensive guides on Git workflows, Markdown, and contributing

## 🗂️ Repository Structure

```
GH-900-Files/
├── cheatsheets/          # Quick reference guides
│   ├── exercises.md
│   ├── git-basics.md
│   └── github-essentials.md
├── templates/            # Reusable templates
│   ├── gitignore/       # .gitignore templates for different languages
│   ├── readme/          # README templates
│   └── github/          # GitHub issue and PR templates
├── workflows/            # GitHub Actions workflow examples
│   ├── nodejs-ci.yml
│   ├── python-ci.yml
│   ├── deploy-pages.yml
│   └── release.yml
└── guides/               # Detailed guides
    ├── getting-started.md
    ├── markdown-guide.md
    ├── contributing.md
    └── git-workflows.md
```

## 🚀 Quick Start

### For Course Participants

1. **Star this repository** ⭐ to bookmark it for easy access
2. Browse the materials relevant to your current learning topic
3. Use the templates as starting points for your projects
4. Reference the cheat sheets when you need quick help

### Using Templates

To use any template from this repository:

```bash
# Clone this repository
git clone https://github.com/mkennten/GH-900-Files.git

# Copy the template you need to your project
cp GH-900-Files/templates/gitignore/Node.gitignore myproject/.gitignore
```

Or simply copy the content directly from GitHub's web interface.

## 📖 Available Resources

### Cheat Sheets

- [**Git Basics**](cheatsheets/git-basics.md) - Essential Git commands and concepts
  - Configuration
  - Basic workflow (add, commit, push)
  - Branching and merging
  - Remote repositories
  - Undoing changes
  - Stashing and tagging

- [**GitHub Essentials**](cheatsheets/github-essentials.md) - GitHub-specific features and workflows
  - Repositories and cloning
  - Pull requests and code review
  - Issues and project management
  - GitHub Actions
  - Security features
  - GitHub CLI

### Templates

#### .gitignore Templates
- [Node.js](templates/gitignore/Node.gitignore)
- [Python](templates/gitignore/Python.gitignore)
- [Java](templates/gitignore/Java.gitignore)

#### README Templates
- [Basic README](templates/readme/basic-readme.md) - Simple project README
- [Detailed README](templates/readme/detailed-readme.md) - Comprehensive project documentation

#### GitHub Templates
- [Bug Report Template](templates/github/ISSUE_TEMPLATE_bug_report.md)
- [Feature Request Template](templates/github/ISSUE_TEMPLATE_feature_request.md)
- [Pull Request Template](templates/github/PULL_REQUEST_TEMPLATE.md)

### Workflows

Example GitHub Actions workflows for common scenarios:

- [**Node.js CI**](workflows/nodejs-ci.yml) - Build, test, and lint Node.js projects
- [**Python CI**](workflows/python-ci.yml) - Test Python projects with pytest
- [**Deploy to GitHub Pages**](workflows/deploy-pages.yml) - Automated deployment
- [**Release Workflow**](workflows/release.yml) - Automated releases and npm publishing

### Guides

Comprehensive guides for deeper understanding:

- [**Getting Started**](guides/getting-started.md) - Complete beginner's guide
  - Installing Git
  - Creating your first repository
  - Making your first commit
  - Pushing to GitHub
  - Common commands and troubleshooting

- [**Markdown Guide**](guides/markdown-guide.md) - Complete guide to Markdown syntax
  - Basic and extended syntax
  - GitHub-specific features
  - Best practices
  - Common mistakes to avoid

- [**Contributing Guidelines**](guides/contributing.md) - How to contribute to projects
  - Setting up development environment
  - Coding standards
  - Commit message conventions
  - Pull request process

- [**Git Workflows**](guides/git-workflows.md) - Different Git workflow strategies
  - Feature Branch Workflow
  - Gitflow Workflow
  - GitHub Flow
  - Trunk-Based Development
  - Forking Workflow

## 🎯 Learning Path

Recommended order for course materials:

### Complete Beginners

1. **Start Here: Getting Started Guide**
   - Read the [Getting Started Guide](guides/getting-started.md)
   - Install Git and create a GitHub account
   - Create your first repository and make your first commit

2. **Learn Git Basics**
   - Review the [Git Basics Cheat Sheet](cheatsheets/git-basics.md)
   - Practice basic commands in a test repository

3. **Learn GitHub Features**
   - Read the [GitHub Essentials Cheat Sheet](cheatsheets/github-essentials.md)
   - Create your first pull request and issue

### Intermediate Users

1. **Understand Workflows**
   - Study [Git Workflows Guide](guides/git-workflows.md)
   - Choose a workflow that fits your project

2. **Master Documentation**
   - Learn from the [Markdown Guide](guides/markdown-guide.md)
   - Create a great README for your project

3. **Set Up Your Project**
   - Use appropriate .gitignore templates
   - Add issue and PR templates
   - Set up GitHub Actions workflows

### Contributing to Open Source

1. Read the [Contributing Guidelines](guides/contributing.md)
2. Understand the Forking Workflow from [Git Workflows](guides/git-workflows.md)
3. Use the PR template when contributing

## 💡 Tips for Success

- **Practice regularly** - Git and GitHub skills improve with consistent use
- **Use branches** - Always create feature branches for new work
- **Write good commit messages** - Future you will thank present you
- **Review before committing** - Use `git diff` to check your changes
- **Learn keyboard shortcuts** - They'll save you time
- **Read documentation** - Official docs are comprehensive and helpful
- **Ask questions** - The community is helpful and welcoming

## 🔗 Additional Resources

### Official Documentation
- [Git Documentation](https://git-scm.com/doc)
- [GitHub Docs](https://docs.github.com/)
- [GitHub Skills](https://skills.github.com/)

### Interactive Learning
- [Git-it](https://github.com/jlord/git-it-electron) - Desktop app for learning Git
- [Learn Git Branching](https://learngitbranching.js.org/) - Interactive Git visualization
- [GitHub Learning Lab](https://lab.github.com/)

### Books
- [Pro Git](https://git-scm.com/book/en/v2) - Free online book
- [GitHub for Dummies](https://www.dummies.com/programming/github/)

### Community
- [GitHub Community](https://github.com/community)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/git)

## 🤝 Contributing

Found an error or want to add more resources? Contributions are welcome!

1. Fork this repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Please ensure your contributions align with the course objectives and maintain the quality and clarity of existing materials.

## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ✉️ Contact

For questions about the course or these materials:
- Create an issue in this repository
- Contact the course instructor

## 🌟 Acknowledgments

Special thanks to all contributors and the GitHub community for making learning Git and GitHub accessible to everyone.

---

**Happy Learning!** 🚀

*Last updated: 2025*

GH-900-Files

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README