Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (45 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

59 lines (45 loc) · 1.43 KB

Contributing to dev-tips

Types of Contributions

  • Tips: 200-500 word quick advice
  • Guides: 1000+ word tutorials
  • Concepts: 500-1000 word explanations
  • Debugging: Error solutions
  • Tools: Tool recommendations
  • Resources: Curated links

Content Guidelines

Writing Style

  • Clear and concise
  • Action-oriented
  • Include examples
  • Beginner-friendly explanations

Formatting

  • Use proper Markdown
  • Include code blocks with language tags
  • Add headings for structure
  • Link to related content

Quality Standards

  • No plagiarism - cite sources
  • Test all code examples
  • Proofread for errors
  • Use inclusive language

Submission Process

  1. Fork the repository
  2. Create branch: git checkout -b feature/your-contribution
  3. Add content following guidelines
  4. Update index: Add to relevant README.md
  5. Commit: git commit -m 'Add: description'
  6. Push: git push origin feature/your-contribution
  7. Open Pull Request with clear description

File Naming

  • Use kebab-case: my-new-tip.md
  • Be descriptive: fixing-merge-conflicts.md not fix.md
  • Match content: filename should reflect the title

Before Submitting

  • Content follows guidelines
  • All code examples tested
  • Markdown properly formatted
  • Section README.md updated
  • Links work correctly
  • No spelling/grammar errors

🙏 Thank You!

Your contributions help developers worldwide!