Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (56 loc) · 2.62 KB

CONTRIBUTING.md

File metadata and controls

78 lines (56 loc) · 2.62 KB
Raw

Contributing to SmartDocs

Thanks for your interest! SmartDocs is an open-source project and we welcome contributions of all kinds.

Ways to Contribute

🐛 Report a Bug

Found something broken? Open an issue. Include:

  • What you were doing
  • What you expected to happen
  • What actually happened
  • Browser / Node version if relevant

💡 Request a Feature

Have an idea? Open an issue. Describe:

  • The problem you're trying to solve
  • How SmartDocs could help
  • Any alternatives you've considered

💬 Ask a Question

Start a discussion. No question is too small — the community is here to help.

🔧 Submit Code

  1. Fork the repo
  2. Create a branch: git checkout -b feature/your-feature
  3. Make your changes (see AGENTS.md for AI coding agent guidance)
  4. Run npm run build — must succeed with zero TypeScript errors
  5. Push and open a pull request

📝 Improve Documentation

Docs live in content/. Fix typos, add examples, or write new pages. Same PR process as code.

🎨 Share Your Site

Built something with SmartDocs? Show it off in Discussions!

Development Setup

git clone https://github.com/jm27/smartdocs.git
cd smartdocs
npm install
npm run build:graph
npm run dev

Open http://localhost:3000. See README.md for full setup instructions.

Before Submitting

  • TypeScript compiles: npx tsc --noEmit
  • Build succeeds: npm run build
  • Graph index is up to date: npm run build:graph
  • Your change follows existing code style (we optimize for readability, not cleverness)
  • If you added content pages, they follow the existing naming conventions

Style Guide

  • TypeScript: strict mode, no any unless unavoidable
  • Components: client components only when needed ("use client" directive)
  • CSS: custom properties for theming, no Tailwind utility classes (we use a hand-crafted design system)
  • Comments: only for non-obvious decisions. The code should be self-documenting.
  • Commits: concise, imperative mood ("fix:", "feat:", "docs:", "refactor:")

Getting Help

License

By contributing, you agree that your contributions will be licensed under the MIT License.