Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
123 lines (87 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

123 lines (87 loc) · 3.84 KB

Contributing to Practical AI Knowledgebase

Thank you for your interest in contributing to this knowledge base! We welcome all contributions that help the community learn and share knowledge about AI in software engineering.

🎯 Ways to Contribute

1. Ask Questions (Open an Issue)

If you have questions or want to learn about specific topics:

  1. Check if a similar issue already exists in the Issues tab
  2. If not, click New Issue
  3. Use a clear, descriptive title
  4. Provide context about what you want to learn
  5. Add relevant labels if available

Example Issue Titles:

  • "How do I set up GitHub Copilot with VS Code?"
  • "Looking for resources on MCP server implementations"
  • "Best practices for AI code review?"

2. Share Knowledge (Open a Pull Request)

If you have content to share:

  1. Fork the repository - Click the "Fork" button at the top right
  2. Clone your fork - git clone https://github.com/YOUR-USERNAME/practical-ai-knowledgebase.git
  3. Create a branch - git checkout -b add-your-topic
  4. Add your content - Place files in the appropriate directory
  5. Commit your changes - git commit -m "Add resource on [topic]"
  6. Push to your fork - git push origin add-your-topic
  7. Open a Pull Request - Go to the original repository and click "New Pull Request"

📂 Where to Add Content

Choose the directory that best fits your content:

  • skills/ - AI coding capabilities, features, tool comparisons
  • hooks/ - Git hooks, IDE extensions, CI/CD integrations
  • mcp/ - Model Context Protocol implementations and guides
  • agents/ - AI agents, autonomous systems, agent frameworks
  • general-notes/ - Observations, meeting notes, ideas, discoveries
  • how-tos/ - Step-by-step tutorials and setup guides

If you're unsure, place it in general-notes/ and mention it in your PR description.

✍️ Content Guidelines

File Naming

  • Use descriptive, lowercase names with hyphens: github-copilot-setup.md
  • For code: use appropriate extensions: example-agent.py, mcp-server.js

Markdown Files

  • Start with a clear title (# Heading)
  • Include a brief description of what the content covers
  • Use proper markdown formatting
  • Add links to original sources when applicable

Code Examples

  • Include comments explaining what the code does
  • Specify language/framework requirements
  • Add usage examples if applicable

Links and Resources

  • Provide context - don't just drop a link
  • Explain why the resource is valuable
  • Include publication date for time-sensitive content

📝 Pull Request Template

When opening a PR, please include:

## Description
Brief description of what you're adding

## Directory
Which directory did you add content to?

## Type of Content
- [ ] Tutorial/How-To
- [ ] Code Example
- [ ] Link to Resource
- [ ] Documentation
- [ ] Notes/Observations
- [ ] Other (please specify)

## Additional Context
Any other information that would be helpful for reviewers

🔍 Review Process

  1. A maintainer will review your PR
  2. They may suggest changes or improvements
  3. Once approved, your PR will be merged
  4. Your contribution will be visible to everyone!

⚖️ Content Standards

Please ensure your contributions:

  • Are relevant to AI in software engineering
  • Are respectful and professional
  • Don't contain proprietary or confidential information
  • Include proper attribution for others' work
  • Are accurate to the best of your knowledge

🤔 Questions?

If you have questions about contributing:

  1. Check existing Issues and Pull Requests
  2. Open a new issue with your question
  3. Tag it appropriately

📜 License

By contributing, you agree that your contributions will be licensed under the same license as this repository.

Thank you for helping build this knowledge base! 🙏