Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (43 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

56 lines (43 loc) · 1.73 KB

Contributing to Syntactic

Thank you for your interest in contributing to Syntactic! We welcome contributions from the community to help make this platform better for developers.

🚀 Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/yourusername/syntactic.git
cd syntactic
  3. Install dependencies: 
    npm install
  4. Set up environment variables: Copy .env.example to .env.local and add your keys (Supabase, etc.).

🛠️ Development Workflow

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/amazing-feature
# or
git checkout -b fix/annoying-bug
  2. Make your changes.
  3. Run the development server to test: 
    npm run dev

📝 Code Guidelines

  • TypeScript: We use TypeScript. Please ensure your code is strongly typed and free of any where possible.
  • Styling: We use Tailwind CSS. Try to stick to existing utility classes and design tokens.
  • Linting: Run npm run lint before committing to ensure your code follows our style guide.

📥 Submitting a Pull Request

  1. Push your branch to your fork: 
    git push origin feature/amazing-feature
  2. Open a Pull Request against the main branch of the original repository.
  3. Describe your changes clearly in the PR description.
  4. Wait for review. We'll do our best to review your code promptly!

🐛 Reporting Issues

If you find a bug or have a feature request, please open an issue in the repository. Provide as much detail as possible to help us understand the problem or idea.

Happy Coding! 🚀