Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (39 loc) · 1.26 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.26 KB

Contributing to MemoryLink AR

We'd love to have you contribute to MemoryLink AR! Here's how you can help.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/MemoryLink-AR.git
  3. Create a branch: git checkout -b feat/your-feature-name
  4. Install dependencies: npm install

Development

npm run dev  # Start development server
npm run lint # Check linting
npm run build # Build for production

Code Style

  • Use TypeScript for all new components
  • Follow the existing file structure
  • Use descriptive variable/function names
  • Add comments for complex logic

Commit Messages

Use conventional commit format:

  • feat: for new features
  • fix: for bug fixes
  • perf: for performance improvements
  • docs: for documentation
  • ci: for CI/CD changes
  • chore: for dependency updates

Example: feat: add 3D model overlay support

Pull Requests

  1. Keep PRs focused on a single feature/fix
  2. Write clear PR descriptions
  3. Reference related issues
  4. Ensure all tests pass (linter)

Reporting Issues

  • Use the GitHub Issues tab
  • Provide a clear description
  • Include steps to reproduce (if it's a bug)
  • Share your device/browser info

Questions?

Open a discussion or issue. We're here to help!