Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (83 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

116 lines (83 loc) · 2.29 KB

Contributing to Strata

Thank you for your interest in contributing to Strata!

Ways to Contribute

1. Star the Repo

The simplest contribution—helps others discover Strata.

2. Share Your Experience

  • Write about how you use Strata
  • Share on LinkedIn, Twitter, or your blog
  • Present at meetups or conferences

3. Submit Case Studies

Have you implemented AI portfolio management? Share your story:

  • What challenge did you face?
  • How did you solve it?
  • What were the results?

Create a PR adding your case study to /case-studies/.

4. Improve Documentation

  • Fix typos or unclear explanations
  • Add examples
  • Translate to other languages
  • Improve the guides

5. Add Templates

Create new templates for:

  • Different industries
  • Specific use cases
  • Alternative formats (Notion, Airtable, etc.)

6. Enhance the Dashboard

  • Bug fixes
  • New features
  • Performance improvements
  • Accessibility improvements

How to Contribute Code

Setup

# Fork the repo on GitHub, then:
git clone https://github.com/YOUR-USERNAME/strata
cd strata/dashboard
npm install
npm run dev

Making Changes

  1. Create a branch: git checkout -b feature/your-feature
  2. Make your changes
  3. Test locally: npm run dev
  4. Build to verify: npm run build
  5. Commit: git commit -m "Add your feature"
  6. Push: git push origin feature/your-feature
  7. Create a Pull Request

Code Style

  • Use TypeScript
  • Follow existing patterns
  • Add comments for complex logic
  • Keep components focused and small

Commit Messages

Use clear, descriptive commit messages:

  • feat: add dark mode toggle
  • fix: resolve chart rendering issue
  • docs: update deployment guide
  • style: format code with prettier

Reporting Issues

Bug Reports

Include:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce
  • Browser/environment details
  • Screenshots if helpful

Feature Requests

Include:

  • The problem you're trying to solve
  • Your proposed solution
  • Alternative solutions considered
  • Who would benefit

Questions?

  • Open an issue for general questions
  • Reach out on LinkedIn

Code of Conduct

Be respectful and constructive. We're all here to build something useful.

Thank you for contributing to Strata!