Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (73 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

103 lines (73 loc) · 2.69 KB
Raw

Contributing to The Logic Lab

Thank you for your interest in contributing to this knowledge notebook!

Philosophy

This notebook captures practical, real-world knowledge. Each entry should be:

  • Clear - Written in plain language
  • Concise - Get to the insight quickly
  • Practical - Oriented toward usefulness
  • Insightful - Focused on what you learned
  • Non-academic - Avoid overly theoretical language

Entry Structure

Each entry may include some or all of the following:

# Entry Title

## Context
What's the situation or problem?

## Observation
What did you observe or notice?

## Insight
What's the key idea or principle?

## Example
Real example or case study

## Lesson
What's the takeaway?

## Related Entries
Links to connected ideas

## Tags
#example #pattern #learning

How to Contribute

  1. Fork the repository
  2. Create a branch for your contribution
  3. Add your entry in the appropriate folder
  4. Follow the entry structure above
  5. Commit with a clear message
  6. Push to your fork
  7. Create a Pull Request with a description

Folder Guidelines

  • notes/ - Individual observations and thinking
  • examples/ - Real-world examples and case studies
  • references/ - External resources and sources
  • experiments/ - Learnings from deliberate experimentation
  • comparisons/ - Comparative analysis entries
  • patterns/ - Identified patterns and frameworks
  • ideas/ - New ideas and conceptual explorations
  • questions/ - Thinking questions and prompts
  • summaries/ - Condensed summaries and synthesis
  • assets/ - Visual materials, diagrams, images

File Naming Convention

Use descriptive, lowercase filenames with hyphens:

observations-on-key-topic.md
case-study-example-name.md
experiment-test-results.md

Writing Tips

  1. Be specific - Use concrete examples
  2. Show, don't just tell - Illustrate with examples
  3. Be honest - Include failures and uncertainties
  4. Connect ideas - Reference related entries
  5. Use tags - Add tags for easy discovery
  6. Format clearly - Use headings and bullet points
  7. Invite reflection - Leave open questions

Quality Standards

  • Entries should be thoughtful and well-considered
  • Examples should be realistic and verifiable
  • References should be properly cited
  • No spam or commercial promotion
  • Respect others' intellectual property

Review Process

All contributions will be reviewed to ensure they meet our standards. We may request clarification, suggest improvements, or collaborate on refinement.

License

All contributions are shared under the same license as the repository (MIT).

Thank you for helping build this knowledge system!