chore: add license and contributing md to main

stevesarmiento · stevesarmiento · commit 0d878e27d9d4 · 2025-12-01T12:52:55.000-08:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,105 @@
+# Contributing to ConnectorKit
+
+Thank you for your interest in contributing! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+1. **Fork the repository**
+2. **Clone your fork**
+
+    ```bash
+    git clone https://github.com/your-username/connectorkit.git
+    cd connectorkit
+    ```
+
+3. **Install dependencies**
+
+    ```bash
+    pnpm install
+    ```
+
+4. **Create a branch**
+    ```bash
+    git checkout -b feature/your-feature-name
+    ```
+
+## Project Structure
+
+- `packages/connector/` - Core wallet connector with React hooks and headless client
+- `packages/debugger/` - Development debug panel with transaction analysis
+- `examples/next-js/` - Example Next.js application with shadcn/ui
+
+## Development Workflow
+
+### Running the Example
+
+```bash
+cd examples/next-js
+pnpm dev
+```
+
+### Code Style
+
+- Use TypeScript for all new code
+- Follow the existing code style (Prettier + ESLint)
+- Use functional and declarative patterns; avoid classes
+- Prefer named exports for components
+
+### Testing
+
+- Add tests for new functionality
+- Ensure all tests pass: `pnpm test`
+- Uses Vitest for testing
+
+### Before Submitting
+
+```bash
+pnpm lint        # Lint code
+pnpm type-check  # Type check
+pnpm build       # Build all packages
+pnpm test        # Run tests
+```
+
+## Pull Request Guidelines
+
+1. **Clear Description** - Explain what changes you made and why
+2. **Link Issues** - Reference any related issues
+3. **Small PRs** - Keep changes focused and atomic
+4. **Tests** - Include tests for new functionality
+5. **Documentation** - Update README/docs if needed
+
+## Wallet Standard Guidelines
+
+When working with wallet integration:
+
+- Follow [Wallet Standard](https://github.com/wallet-standard/wallet-standard) best practices
+- Ensure compatibility with all compliant wallets
+- Test with multiple wallets (Phantom, Solflare, Backpack, etc.)
+- Test on devnet before mainnet
+
+## Bug Reports
+
+Include:
+
+- Clear description of the issue
+- Steps to reproduce
+- Expected vs actual behavior
+- Environment details (Node.js version, browser, wallet)
+- Relevant error messages
+
+## Feature Requests
+
+- Check existing issues first
+- Provide clear use case and requirements
+- Consider Wallet Standard compatibility
+- Think about impact on both React and headless usage
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+## Questions
+
+- Open an issue for questions
+- Check existing documentation in package READMEs
+- Review [Wallet Standard specification](https://github.com/wallet-standard/wallet-standard)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Solana Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 
diff --git a/packages/connector/CONTRIBUTING.md b/packages/connector/CONTRIBUTING.md
@@ -38,90 +38,70 @@ packages/connector/
 │   │   ├── transaction/  # Transaction signing
 │   │   ├── cluster/      # Network/cluster management
 │   │   ├── health/       # Health checks and diagnostics
-│   │   └── adapters/     # Storage and wallet adapters
+│   │   ├── adapters/     # Storage and wallet adapters
+│   │   ├── kit-signers/  # @solana/kit transaction signers
+│   │   ├── kit-utils/    # @solana/kit utilities
+│   │   ├── errors/       # Error types and handling
+│   │   └── utils/        # Internal utilities
 │   ├── hooks/            # React hooks
 │   ├── components/       # React components (elements)
 │   ├── ui/               # UI providers and error boundaries
 │   ├── config/           # Configuration utilities
 │   ├── types/            # TypeScript type definitions
-│   └── utils/            # Utility functions
-├── __tests__/            # Test utilities and fixtures
-├── examples/             # Example implementations
+│   ├── utils/            # Public utility functions
+│   └── __tests__/        # Test utilities and fixtures
 └── dist/                 # Build output (gitignored)
 ```
 
 ## Development Workflow
 
+### Running the Example App
+
+```bash
+# From repository root
+cd examples/next-js
+pnpm dev
+```
+
 ### Code Style
 
 - Use TypeScript for all new code
 - Follow the existing code style (Prettier + ESLint)
-- Use functional and declarative programming patterns; avoid classes
+- Use functional and declarative patterns; avoid classes
 - Prefer named exports for components
 - Use descriptive variable names with auxiliary verbs (e.g., `isLoading`, `hasError`)
-- Write meaningful commit messages following [Conventional Commits](https://www.conventionalcommits.org/)
 
 ### Testing
 
-- Add tests for new functionality
 - Tests are co-located with source files (`.test.ts` or `.test.tsx`)
-- Ensure all tests pass: `pnpm test`
-- Run tests in watch mode during development: `pnpm test:watch`
-- Maintain or improve code coverage (target: 80%+)
-- Use Vitest for testing
+- Run tests: `pnpm test`
+- Watch mode: `pnpm test:watch`
+- Uses Vitest
 
 ### Before Submitting
 
 ```bash
-# From the repository root
-cd packages/connector
-
-# Format code
-pnpm format
-
-# Lint code
-pnpm lint
-
-# Type check
-pnpm type-check
-
-# Build
-pnpm build
-
-# Run tests
-pnpm test
-
-# Check bundle size
-pnpm size
-```
-
-### Running Examples
-
-Test your changes with the example app:
-
-```bash
-# From repository root
-cd examples/next-js
-pnpm dev
+# From packages/connector
+pnpm lint        # Lint code
+pnpm type-check  # Type check
+pnpm build       # Build
+pnpm test        # Run tests
 ```
 
 ## Pull Request Guidelines
 
-1. **Clear Description**: Explain what changes you made and why
-2. **Link Issues**: Reference any related issues (e.g., "Fixes #123")
-3. **Small PRs**: Keep changes focused and atomic - one feature or fix per PR
-4. **Tests**: Include tests for new functionality
-5. **Documentation**: Update README.md if needed
-6. **Type Safety**: Ensure TypeScript types are correct and exported properly
-7. **Bundle Size**: Be mindful of bundle size impact (check with `pnpm size`)
+1. **Clear Description** - Explain what changes you made and why
+2. **Link Issues** - Reference any related issues (e.g., "Fixes #123")
+3. **Small PRs** - Keep changes focused - one feature or fix per PR
+4. **Tests** - Include tests for new functionality
+5. **Documentation** - Update README.md if needed
 
 ### PR Checklist
 
 - [ ] Code follows the project's style guidelines
 - [ ] Tests added/updated and passing
 - [ ] TypeScript types are correct
-- [ ] Documentation updated (README.md, code comments)
-- [ ] Bundle size impact considered
+- [ ] Documentation updated if needed
 - [ ] No breaking changes (or clearly documented if intentional)
 
 ## Development Guidelines
@@ -141,112 +121,25 @@ pnpm dev
 ### Transaction Signing
 
 - Support both `@solana/kit` (modern) and `@solana/web3.js` (legacy) APIs
-- Ensure proper error handling and user feedback
+- Ensure proper error handling
 - Test transaction signing with real wallets on devnet
 
-### Storage
-
-- Use enhanced storage adapters with validation
-- Ensure SSR compatibility
-- Handle storage errors gracefully (private browsing, quota exceeded)
-
-### Performance
-
-- Minimize re-renders in React hooks
-- Use proper memoization where needed
-- Keep bundle size small (check with `pnpm size`)
-
 ## Bug Reports
 
 Include:
 
 - Clear description of the issue
 - Steps to reproduce
 - Expected vs actual behavior
-- Environment details:
-  - Node.js version
-  - Package version
-  - Browser/OS
-  - Wallet(s) tested
-- Relevant logs or error messages
-- Minimal reproduction if possible
+- Environment details (Node.js version, package version, browser, wallet)
+- Relevant error messages
 
 ## Feature Requests
 
 - Check existing issues first
 - Provide clear use case and requirements
 - Consider Wallet Standard compatibility
 - Think about impact on both React and headless usage
-- Consider bundle size implications
-- Think about backward compatibility
-
-## Testing Guidelines
-
-### Writing Tests
-
-- Co-locate test files with source files
-- Use descriptive test names
-- Test both success and error cases
-- Mock external dependencies (wallets, storage, etc.)
-- Use test fixtures for common data structures
-
-### Test Structure
-
-```typescript
-import { describe, it, expect } from 'vitest';
-import { YourFunction } from './your-file';
-
-describe('YourFunction', () => {
-    it('should handle success case', () => {
-        // Test implementation
-    });
-
-    it('should handle error case', () => {
-        // Test implementation
-    });
-});
-```
-
-### React Hook Testing
-
-```typescript
-import { renderHook } from '@testing-library/react';
-import { useYourHook } from './use-your-hook';
-import { createHookWrapper } from '../__tests__/utils/react-helpers';
-
-describe('useYourHook', () => {
-    it('should return expected values', () => {
-        const { result } = renderHook(() => useYourHook(), {
-            wrapper: createHookWrapper(),
-        });
-        expect(result.current).toBeDefined();
-    });
-});
-```
-
-## Documentation
-
-- Update README.md for user-facing changes
-- Add JSDoc comments for public APIs
-- Include code examples in documentation
-- Keep examples in sync with actual usage
-
-## Code Review Process
-
-1. All PRs require at least one approval
-2. Address review comments promptly
-3. Keep PRs up to date with main branch
-4. Squash commits before merging (if requested)
-
-## Wallet Standard Guidelines
-
-When working with wallet integration:
-
-- Follow Wallet Standard best practices
-- Ensure compatibility with all compliant wallets
-- Handle wallet detection and connection errors gracefully
-- Support multi-account wallets properly
-- Test on devnet before mainnet
 
 ## License
 
@@ -257,8 +150,6 @@ By contributing, you agree that your contributions will be licensed under the MI
 - Open an issue for questions
 - Check existing documentation in README.md
 - Review [Wallet Standard specification](https://github.com/wallet-standard/wallet-standard)
-- Check examples in `examples/next-js` directory
-
-## Thank You!
+- Check the [Next.js example](../../examples/next-js) for usage patterns
 
-Your contributions help make ConnectorKit better for everyone. Thank you for taking the time to contribute!
+Thank you for contributing to ConnectorKit!
