Skip to content

contributing.md

Latest commit

 

History

History
70 lines (51 loc) · 2.52 KB

contributing.md

File metadata and controls

70 lines (51 loc) · 2.52 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to the Programming Best Practices repository! 🎉

📝 How to Contribute

Adding New Resources

  1. Fork the repository
  2. Edit README.md to add your resource in the appropriate section
  3. Submit a pull request with a clear description

Pull Request Guidelines

Please ensure your pull request adheres to the following guidelines:

  • ✅ Make an individual pull request for each suggestion
  • ✅ Add resources to the appropriate category section
  • ✅ Start the resource name with a capital letter
  • ✅ Check your spelling and grammar
  • ✅ Make sure your text editor is set to remove trailing whitespace
  • ✅ Verify all links are working and accessible
  • ✅ Follow the existing format: * [Resource Title](URL) — *@author or description*

Resource Quality Guidelines

We accept resources that are:

  • 📚 From reputable sources (official documentation, known organizations, respected authors)
  • 🔄 Actively maintained or still relevant
  • 🌟 Provide practical, actionable best practices
  • 🆓 Free to access (prefer open source)

Categories

You can suggest resources for:

  • Backend Development (any programming language)
  • Frontend Development (web technologies)
  • Database & Data (SQL, NoSQL, data modeling)
  • Mobile Development (iOS, Android, cross-platform)
  • DevOps & Infrastructure (cloud, CI/CD, security)
  • AI & Data Science (ML, AI tools, data engineering)
  • Development Tools & Practices (code review, collaboration)

🤖 AI Configuration Files

This repository includes configuration files for AI coding assistants and is also a Claude Code plugin:

File Purpose
.claude-plugin/plugin.json Claude Code plugin manifest
skills/ Claude Code auto-invoked skills
commands/ Claude Code slash commands
CLAUDE.md Claude Code instructions
AGENTS.md General AI agent instructions
.agent/ Antigravity configuration
.kiro/ Kiro configuration
.cursorrules Cursor AI rules
.windsurfrules Windsurf AI rules

If you're improving AI integration, please update the relevant configuration files.

💡 Suggesting Improvements

Have ideas for better organization or new features?

🙏 Thank You!

Every contribution helps make this resource better for developers worldwide!