Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
195 lines (151 loc) · 5.94 KB

CONTRIBUTING.md

File metadata and controls

195 lines (151 loc) · 5.94 KB
Raw

🤝 Contributing to GizzZmo's Profile Repository

Thank you for your interest in contributing! This repository serves as a GitHub profile hub and configuration template collection. Your contributions help make this resource more valuable for the entire development community.

🎯 Ways to Contribute

1. 🐛 Bug Reports

If you find issues with existing templates or documentation:

  • Use the Bug Report template
  • Provide clear reproduction steps
  • Include your environment details

2. ✨ Feature Requests

Have ideas for new features or improvements?

3. 📁 Configuration Templates

Share your battle-tested development configurations:

4. 📚 Documentation Improvements

Help improve README, guides, and template documentation:

  • Fix typos or unclear explanations
  • Add missing information
  • Create visual aids or examples

🚀 Getting Started

Prerequisites

  • Git installed on your system
  • Basic knowledge of Markdown
  • Familiarity with the configuration type you're contributing

Development Setup

# Fork and clone the repository
git clone https://github.com/GizzZmo/GizzZmo.git
cd GizzZmo

# Create a feature branch
git checkout -b feature/your-feature-name

# Make your changes
# ... edit files ...

# Test your changes
# Verify templates work in real projects
# Check Markdown rendering

# Commit your changes
git add .
git commit -m "feat: add new VSCode theme configuration"

# Push to your fork
git push origin feature/your-feature-name

# Create a Pull Request

📝 Contribution Guidelines

Code Style

  • Markdown: Follow CommonMark standards
  • JSON: Use 2-space indentation, trailing commas where appropriate
  • Comments: Include helpful comments in configuration files
  • Naming: Use descriptive, consistent naming conventions

Template Requirements

When submitting configuration templates:

✅ Do:

  • Test templates in real projects before submitting
  • Include clear comments explaining each section
  • Provide setup/usage instructions
  • Remove any personal or sensitive information
  • Follow language/framework best practices
  • Include file headers with description and author info

❌ Don't:

  • Submit untested configurations
  • Include personal paths, names, or credentials
  • Add overly specific configurations that won't help others
  • Copy templates without understanding them
  • Submit without proper documentation

Example Template Header:

{
  "name": "Template Name",
  "description": "Brief description of what this template does",
  "author": "Your Name",
  "version": "1.0.0",
  "compatible_with": ["VSCode 1.70+", "Node.js 16+"],
  "last_updated": "2024-01-01",
  
  // Your configuration here...
}

🔍 Review Process

Pull Request Requirements

  • Clear, descriptive PR title and description
  • All tests pass (if applicable)
  • Documentation updated (if needed)
  • Templates tested in real environments
  • No sensitive information included
  • Follows project style guidelines

Review Timeline

  • Initial Response: Within 48 hours
  • Full Review: Within 1 week
  • Merge: After approval and CI passes

🏷️ Issue Labels

We use these labels to organize contributions:

Label Description
bug Something isn't working
enhancement New feature or request
template Configuration template related
documentation Improvements to docs
good first issue Good for newcomers
help wanted Extra attention needed
community Community-driven content
needs-testing Requires validation

🌟 Recognition

Contributors are recognized in several ways:

  • Listed in repository contributors
  • Mentioned in release notes for significant contributions
  • Template attribution in file headers
  • Special thanks in README updates

📞 Getting Help

Need help with your contribution?

  • GitHub Discussions: For general questions
  • Issues: For specific problems
  • Email: jon_arve@icloud.com for private matters

📜 Code of Conduct

Our Standards

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help others learn and grow
  • Maintain professional communication

Unacceptable Behavior

  • Harassment or discrimination
  • Trolling or inflammatory comments
  • Publishing private information
  • Spam or off-topic content

🎵 Special Notes for Music/Creative Tech

This repository especially welcomes contributions related to:

  • Audio development configurations (VST, DAW plugins)
  • Creative coding setups
  • Music production workflows
  • Art + technology intersections
  • Experimental development environments

📚 Resources

Helpful Links

Template Ideas

Looking for inspiration? Consider contributing:

  • Language-specific .gitignore files
  • Framework-specific VSCode settings
  • Docker development configurations
  • CI/CD workflow templates
  • Development environment setups
  • Creative coding configurations

🎉 Thank You!

Every contribution, no matter how small, makes this project better. Whether you're fixing a typo, adding a new template, or suggesting improvements, your effort is appreciated!

"Creativity is intelligence having fun." - Let's build something awesome together! 🚀