Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
147 lines (103 loc) · 3.47 KB

CONTRIBUTING.md

File metadata and controls

147 lines (103 loc) · 3.47 KB

🤝 Contributing to GitHub Actions Learning

Thank you for your interest in contributing! We welcome all types of contributions.

📖 For Complete Guidelines

👉 See README.md for the full submission process.

Quick Contribution Types

🎖️ Submit Your Badge

  1. Complete tasks from TASKS.md
  2. Create submission file in .github/submissions/
  3. Create a PR with your work
  4. Submit issue using 🎖️ Badge Submission template
  5. Auto-labels & assignment happen automatically! 🤖

See README.md - Submission Process for full details.

🐛 Report a Bug

Found an issue? Create an issue using the bug report template.

Include:

  • What you were doing
  • What went wrong
  • Steps to reproduce
  • Your environment

✨ Suggest an Improvement

Have an idea? Create an issue using the feature request template.

Include:

  • Clear description of the feature
  • Why it would help
  • Example use case

📚 Improve Documentation

Found unclear or missing docs? Create an issue using the documentation template.

❓ Ask a Question

Need help? Create an issue using the question template.

💻 Contribute Code Changes

For Non-Badge Work (Documentation, Fixes, Features)

  1. Fork the repository

    # Click Fork button on GitHub

  2. Clone your fork

    git clone https://github.com/YOUR-USERNAME/github-actions-learning.git
cd github-actions-learning

  3. Create a feature branch

    git checkout -b feature/your-feature-name

    Branch naming conventions:

    • feature/description - New features
    • fix/description - Bug fixes
    • docs/description - Documentation updates
    • test/description - Adding tests

  4. Make your changes

    • Edit files as needed
    • For docs: Edit markdown files in docs/ or main markdown files
    • For code: Update sample app or workflows
    • Test your changes locally

  5. Commit your changes

    git commit -m "Clear, descriptive message"

    Good commit messages:

    • Use imperative mood: "Add feature" not "Added feature"
    • Keep it short (50 chars or less)
    • Reference issues: "Fix #123"

  6. Push to your fork

    git push origin feature/your-feature-name

  7. Create a Pull Request

    • Go to GitHub and click "New Pull Request"
    • Use the PR template
    • Describe your changes
    • Link related issues
    • Wait for review

✅ PR Guidelines

Your PR should:

  • Have a clear title and description
  • Reference related issues if any
  • Pass all checks
  • Follow project code style
  • Update docs if needed
  • Include evidence (screenshots for badge PRs)

🎯 All Contributions Welcome

  • 🎖️ Badge submissions
  • 🐛 Bug reports
  • ✨ Feature suggestions
  • 📚 Documentation improvements
  • ❓ Questions & discussions
  • 🔧 Code improvements
  • 🎨 Design suggestions

❓ Questions?

Thank you for contributing! 🙏