Getting Started

Getting Started

Using This Template

1. Create Your Repository

Click "Use this template" button on GitHub, or:

# Clone the starter template
git clone https://github.com/YourUsername/git-starter.git my-project
cd my-project

2. Customize the Files

Required Changes

LICENSE

Replace: [year] [fullname]
With: 2025 Your Name

README.md

• Update project name
• Add project description
• Update usage instructions

Optional Changes

.gitignore

• Uncomment language-specific sections you need
• Add project-specific ignore patterns

CODE_OF_CONDUCT.md

• Add contact information for reporting

SECURITY.md

• Add supported versions info
• Update contact methods

3. First Commit

git add .
git commit -m "chore: customize template for my-project"
git push

4. Enable GitHub Actions

Go to your repository → Settings → Actions → General

• Enable "Read and write permissions"

This allows the auto-release workflow to create tags and releases.

5. Create Initial Release

Option A: Automatic (recommended)

• Just merge code to main
• First release will be v0.0.1

Option B: Start with v1.0.0

git tag -a v1.0.0 -m "Initial release"
git push origin v1.0.0

File Overview

Configuration Files

• .gitignore - What Git should ignore
• .gitattributes - How Git handles files (line endings, etc.)
• .editorconfig - Code formatting rules for editors

Documentation Files

• README.md - Main project documentation
• LICENSE - Legal terms for using your code
• CONTRIBUTING.md - How others can contribute
• CODE_OF_CONDUCT.md - Community guidelines
• SECURITY.md - How to report security issues

GitHub Specific

• .github/pull_request_template.md - Template for pull requests
• .github/workflows/auto-release.yml - Automated releases
• scripts/bump-version.sh - Manual version control

Next Steps

• Read Auto Release Workflow to understand versioning
• Start building your project!
• Invite collaborators