# Contributing to AI Markdown Journal

Thank you for your interest in contributing! This is an open-source starter kit designed to help people build their own AI-powered journaling systems.

## Ways to Contribute

### 1. Share Your Templates
Created a custom template that works well for you? Share it!
- Add to `system/community-templates/`
- Include a README explaining when/how to use it

### 2. Improve Documentation
- Fix typos or unclear instructions
- Add examples and use cases
- Translate to other languages
- Create video tutorials or guides

### 3. Build Integrations
- API integration examples
- Tool-specific connectors
- Automation scripts
- Custom workflows

### 4. Report Issues
Found a bug or have a suggestion?
- Open a GitHub issue
- Be specific and include examples
- Suggest solutions if you have ideas

### 5. Submit Improvements
- Better folder structures
- Enhanced templates
- Workflow optimizations
- System improvements

## Guidelines

### Keep It Simple
This is a **starter kit**, not a complex framework:
- Prioritize simplicity over features
- Focus on what helps beginners
- Avoid over-engineering
- Document clearly

### Stay Framework-Agnostic
Works with any markdown editor:
- No tool-specific dependencies
- Plain markdown only
- Optional integrations, not requirements
- Platform-independent approaches

### Respect Privacy
This is personal journaling:
- Never commit actual journal entries
- Keep examples generic
- Respect user privacy in docs
- Consider security implications

### Be Inclusive
Welcome all skill levels:
- Write for beginners
- Explain technical concepts
- Provide multiple options
- Be encouraging and supportive

## How to Submit

### For Small Changes
- Fork the repository
- Make your changes
- Submit a pull request
- Explain what and why

### For Large Changes
- Open an issue first to discuss
- Get feedback before investing time
- Break into smaller PRs if possible
- Document thoroughly

## Code of Conduct

### Be Kind
- Supportive and encouraging
- Constructive feedback
- Assume good intentions
- Help others learn

### Be Respectful
- Value different approaches
- Welcome diverse perspectives
- Avoid judgment
- Foster psychological safety

### Be Collaborative
- Share credit generously
- Build on others' ideas
- Communicate openly
- Support the community

## Questions?

Open a GitHub issue with the `question` label or start a discussion.

---

**Thank you for helping make journaling more accessible and powerful!**

