chore: update contribution guide

.github/CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 Thank you for your interest in contributing to Better-T-Stack! This document provides guidelines and setup instructions for contributors.
 
+> **⚠️ Important**: Before starting work on any new features or major changes, please open an issue first to discuss your proposal and get approval. We don't want you to waste time on work that might not align with the project's direction or get merged.
+
 ## Project Structure
 
 This repository is organized as a monorepo containing:
@@ -21,7 +23,7 @@ This repository is organized as a monorepo containing:
 
 1. **Clone the repository**
    ```bash
-   git clone https://github.com/better-t-stack/create-better-t-stack.git
+   git clone https://github.com/AmanVarshney01/create-better-t-stack.git
    cd create-better-t-stack
    ```
 
@@ -59,10 +61,6 @@ This repository is organized as a monorepo containing:
 
 ## Contribution Guidelines
 
-### Before You Start
-
-**Please ask before working on any new features!** We don't want to waste your time on features that might not align with the project's direction. Open an issue or discussion first to discuss your proposed changes.
-
 ### Standard Contribution Steps
 
 1. **Create an issue** (if one doesn't exist)
@@ -71,6 +69,8 @@ This repository is organized as a monorepo containing:
    - Discuss the proposed solution
 
 2. **Fork the repository**
+   - Click the "Fork" button on GitHub
+   - Clone your fork locally
 
 3. **Create a feature branch**
    ```bash
@@ -83,30 +83,9 @@ This repository is organized as a monorepo containing:
    - Follow the existing code style
    - Update documentation as needed
 
-5. **Test and format your changes**
+5. **Test and format your changes** (see Testing section below)
-   ```bash
-   # For CLI changes
-   cd apps/cli
-   bun dev:cli
-   
-   # For web changes
-   bun dev:web
-   
-   # Format files
-   bun run format
-   
-   # Run type checks
-   bun check
-   ```
 
-6. **Add changeset** (for CLI-related changes)
+6. **Commit your changes**
-   ```bash
-   bunx changeset select create-better-t-stack
-   # Choose 'patch' for small fixes, 'minor' for features
-   # Never choose 'major'
-   ```
-
-7. **Commit your changes**
    ```bash
    git add .
    git commit -m "feat(web): add your feature description"
@@ -114,21 +93,47 @@ This repository is organized as a monorepo containing:
    git commit -m "fix(cli): fix your bug description"
    ```
 
-8. **Push to your fork**
+7. **Push to your fork**
    ```bash
    git push origin feature/your-feature-name
    ```
 
-9. **Create a Pull Request**
+8. **Create a Pull Request**
    - Link to the related issue
    - Describe your changes
 
 ### Testing
 
+**Before committing, make sure to test your changes:**
+
+```bash
+# For CLI changes
+cd apps/cli
+bun dev:cli
+bun run test
+
+# For web changes
+bun dev:web
+
+# Format files
+bun run format
+```
+
 - **Manual testing**: Test your changes manually to ensure everything works as expected
 - For CLI changes: Test with different configurations and options
 - For web changes: Ensure the site builds and displays correctly
 
+## Commit Conventions
+
+Use conventional commit messages with the appropriate scope:
+
+- `feat(cli): add new CLI feature`
+- `fix(cli): fix CLI bug`
+- `feat(web): add new web feature`
+- `fix(web): fix web bug`
+- `chore(web): update dependencies`
+- `docs: update documentation`
+
 ## Getting Help
 
 - Open an issue for bugs or feature requests

apps/web/content/docs/contributing.mdx

@@ -3,6 +3,8 @@ title: Contributing
 description: How to set up your environment and contribute changes
 ---
 
+> **⚠️ Important**: Before starting work on any new features or major changes, please open an issue first to discuss your proposal and get approval. We don't want you to waste time on work that might not align with the project's direction or get merged.
+
 ## Overview
 
 This project is a monorepo with two main apps:
@@ -10,8 +12,6 @@ This project is a monorepo with two main apps:
 - CLI: `apps/cli`
 - Documentation site: `apps/web`
 
-> Note: Planning to add a new feature? Please open an issue first to confirm it aligns with the project's future goals. We don't want you to spend time on work that might not land.
-
 ## Setup
 
 ### Prerequisites
@@ -48,14 +48,16 @@ bun dev:web
 ## Contribution Flow
 
 1. Open an issue/discussion before starting major work
-2. Create a feature branch
+2. Fork the repository
-3. Make changes following existing code style
+3. Create a feature branch
-4. Update docs as needed
+4. Make changes following existing code style
-5. Test and format
+5. Update docs as needed
+6. Test and format
 
 ```bash
 # CLI
 cd apps/cli && bun dev:cli
+cd apps/cli && bun run test
 
 # Web
 bun dev:web
@@ -67,14 +69,6 @@ bun run format
 bun check
 ```
 
-6. (CLI changes) Add a changeset
-
-```bash
-bunx changeset select create-better-t-stack
-# Choose 'patch' for small fixes, 'minor' for features
-# Never choose 'major'
-```
-
 7. Commit and push
 
 ```bash
@@ -85,6 +79,17 @@ git push origin <your-branch>
 
 8. Open a Pull Request and link any related issues
 
+## Commit Conventions
+
+Use conventional commit messages with the appropriate scope:
+
+- `feat(cli): add new CLI feature`
+- `fix(cli): fix CLI bug`
+- `feat(web): add new web feature`
+- `fix(web): fix web bug`
+- `chore(web): update dependencies`
+- `docs: update documentation`
+
 ## Help
 
 - Issues and Discussions on GitHub