CONTRIBUTING.md

Contributing to Cortex DB Frontend

Thank you for your interest in contributing to Cortex DB! We welcome contributions from the community to help make this project better.

Getting Started

1. Fork the repository on GitHub.
2. Clone your fork locally:

   git clone https://github.com/your-username/cortex.git
   cd cortex

3. Create a new branch for your feature or bugfix:

   git checkout -b feature/amazing-feature

Development

1. Install dependencies:

   pnpm install

2. Set up your environment variables (see README.md).
3. Start the development server:

   pnpm dev

Committing Changes

Please follow the Conventional Commits specification for your commit messages.

• feat: add new button variant
• fix: resolve sidebar navigation issue
• style: update landing page typography

Pull Requests

1. Push your branch to your fork.
2. Submit a Pull Request to the main branch of the original repository.
3. Provide a clear description of your changes and any relevant issue numbers.

Code Style

• We use React with TypeScript and Tailwind CSS.
• Ensure your code passes all linting checks:

  pnpm lint

Thank you for contributing!