Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (86 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

124 lines (86 loc) · 3.38 KB
Raw

🤝 Contributing to The Complete GitHub License Guide

First off, thank you for considering contributing! This project exists to help developers understand open-source licensing, and your contribution can make a real difference.

📋 Table of Contents

📜 Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior by opening an issue.

💡 How Can I Contribute?

📝 Content Improvements

  • Fix typos, grammar, or formatting issues
  • Add clearer explanations or analogies
  • Improve existing use case examples
  • Add more real-world case studies

📊 New Content

  • Add comparison tables between specific licenses
  • Create decision flowcharts for specific scenarios
  • Add industry-specific licensing guides (e.g., "Licensing for Game Dev")
  • Write FAQs for common licensing questions

🌍 Translations

  • Translate any LICENSE_NAME.md or USE_CASE.md into other languages
  • Create a translated README.md
  • Follow the naming convention: LICENSE_NAME_[lang].md (e.g., LICENSE_NAME_hi.md for Hindi)

🐛 Bug Reports

  • Incorrect license information
  • Broken links
  • Outdated project examples

🚀 Getting Started

1. Fork the Repository

Click the Fork button at the top right of the repository page.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/Github-License.git
cd Github-License

3. Create a Branch

git checkout -b feature/your-improvement

4. Make Your Changes

Edit or create files following the Style Guide.

5. Commit & Push

git add .
git commit -m "docs: add new use case for MIT license"
git push origin feature/your-improvement

6. Open a Pull Request

Go to your fork on GitHub and click "New Pull Request".

🎨 Style Guide

File Structure

Each license folder should contain:

  • LICENSE_NAME.md — License documentation
  • USE_CASE.md — When to use this license

Markdown Formatting

  • Use tables for comparisons (✅/❌ for permissions)
  • Use code blocks for license text excerpts
  • Use emoji for visual clarity (📜, ✅, ❌, 🏢, 🔑, 🧠)
  • Include a "Developer's Perspective" quote in each license file
  • Include a "Decision Checklist" in each use case file
  • Add "Further Reading" links at the bottom

Commit Messages

Follow Conventional Commits:

docs: add new use case for BSD license
fix: correct patent grant info for Apache 2.0
feat: add Hindi translation for MIT license
chore: update links in README

✅ Pull Request Process

  1. Ensure your changes follow the style guide
  2. Update the README.md if you add new folders/files
  3. Verify all links work correctly
  4. Write a clear PR description explaining your changes
  5. Be responsive to review feedback

🙏 Thank You!

Every contribution, no matter how small, helps developers worldwide make better licensing decisions. You're making open source better! 🌟