Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (57 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

81 lines (57 loc) · 2.82 KB

Contribution Guidelines

Thank you for your interest in contributing to Awesome TigerStyle! This list aims to be the definitive collection of resources for the TigerStyle programming philosophy.

How to Contribute

  1. Fork this repository
  2. Create a branch for your addition: git checkout -b add-resource-name
  3. Add your resource to the appropriate section in README.md
  4. Commit your changes: git commit -am 'Add [resource name]'
  5. Push to your branch: git push origin add-resource-name
  6. Submit a Pull Request

What We're Looking For

High-Quality Resources

  • Articles that explain or apply TigerStyle principles
  • Talks/Videos discussing TigerStyle or related philosophies
  • Projects that demonstrably follow TigerStyle practices
  • Tools that help implement TigerStyle guidelines
  • Books/Papers that influenced or align with TigerStyle

Quality Standards

Resources should be:

  • Relevant — Directly related to TigerStyle or its core principles (safety, performance, developer experience)
  • Valuable — Provide genuine insight or utility
  • Accessible — Available to the public (free or reasonably priced)
  • Active — Not abandoned (for projects/tools)
  • Well-written — Clear, accurate, and professional

Formatting Guidelines

Follow the existing format:

- [Resource Name](https://example.com/) — Brief description ending with a period.

Guidelines:

  • Use Title Case for resource names
  • Keep descriptions concise (one sentence)
  • End descriptions with a period
  • Place new entries alphabetically within their section, or chronologically for talks/articles
  • Use an em dash (—) not a hyphen (-) between name and description

Section Guidelines

Section What Belongs
Official Resources First-party TigerBeetle/TigerStyle content
Talks & Videos Conference talks, tutorials, podcasts
Articles & Blog Posts Written content explaining TigerStyle
Community Discussions Notable forum/HN/Reddit threads
Related Projects Codebases following TigerStyle
Zig Resources Zig-specific content relevant to TigerStyle
Foundational Reading Papers, books, and works that influenced TigerStyle
Tools & Linters Software that helps implement TigerStyle

What Not to Add

  • Duplicate resources
  • Paywalled content without free alternatives
  • Low-quality or spam content
  • Resources unrelated to TigerStyle principles
  • Self-promotional content without genuine value

Code of Conduct

Be respectful and constructive. We're here to build a valuable resource for the community.

Questions?

Open an issue if you're unsure whether a resource fits or have questions about contributing.

Thank you for helping make Awesome TigerStyle the best resource for the TigerStyle community! 🐯