Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.65 KB
Raw

Contributing to Developer Toolkit Guide

Thank you for your interest in contributing! This project helps developers leverage GitHub Education tools effectively.

Ways to Contribute

Report Issues

  • Found a bug or outdated documentation? Open an issue
  • Include the tool name, what you expected, and what actually happened

Suggest Improvements

  • Have an idea for a new recipe or language guide? Open an issue to discuss
  • Want to add support for another GitHub Education tool? Let's talk!

Submit Pull Requests

  1. Fork the repository
  2. Create a branch for your changes: 
    git checkout -b feature/add-new-tool
  3. Make your changes
  4. Test your changes - ensure links work, code examples are correct
  5. Commit with a clear message: 
    git commit -m "Add integration guide for NewTool"
  6. Push and open a PR

What We're Looking For

Documentation

  • Clear, concise writing
  • Working code examples
  • Accurate dashboard URLs and setup instructions

Templates

  • Tested configuration files
  • Comments explaining each option
  • Environment variable examples (never real keys!)

Claude Code Plugin

  • Well-structured commands and skills
  • Helpful descriptions
  • Error handling guidance

Code Style

  • Markdown: Use headers, code blocks, and tables for clarity
  • Code examples: Include language identifiers in code blocks
  • Links: Use relative links within the repo, absolute links for external

Questions?

Open an issue or start a discussion. We're happy to help!

License

By contributing, you agree that your contributions will be licensed under the MIT License.