Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
174 lines (131 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

174 lines (131 loc) · 4.51 KB
Raw

Contributing to Pinky's AI Projects

Thank you for your interest in contributing to our Sign Language AI Chatbot Platform! We welcome contributions from developers, researchers, and accessibility advocates.

🤝 How to Contribute

Reporting Issues

  1. Check existing issues to avoid duplicates
  2. Use the issue templates provided
  3. Include detailed reproduction steps
  4. Add relevant labels (bug, enhancement, documentation)

Code Contributions

  1. Fork the repository
  2. Create a feature branch: `git checkout -b feature/your-feature-name`
  3. Make your changes following our coding standards
  4. Test your changes thoroughly
  5. Commit with clear messages: `git commit -m "Add: new feature description"`
  6. Push to your fork: `git push origin feature/your-feature-name`
  7. Create a Pull Request with detailed description

Development Setup

```bash

Clone your fork

git clone https://github.com/YOUR_USERNAME/pinky-ai-projects.git cd pinky-ai-projects

Install dependencies

npm install

Set up environment variables

cp .env.example .env.local

Start development server

npm run dev ```

📋 Coding Standards

TypeScript/React

  • Use TypeScript for all new code
  • Follow React best practices and hooks patterns
  • Use functional components over class components
  • Implement proper error boundaries

Styling

  • Use Tailwind CSS for styling
  • Follow mobile-first responsive design
  • Maintain consistent spacing and typography
  • Use shadcn/ui components when possible

AI/ML Contributions

  • Document model performance metrics
  • Include training data sources and licensing
  • Follow ethical AI guidelines
  • Test for bias and accessibility

🎯 Areas for Contribution

High Priority

  • Additional sign language dialects (BSL, ASL variants)
  • Performance optimizations for real-time processing
  • Mobile app development (React Native)
  • Accessibility improvements (screen readers, keyboard navigation)

Medium Priority

  • Additional AWS service integrations
  • Blockchain token system implementation
  • API documentation and examples
  • Automated testing suite

Documentation

  • API documentation
  • Deployment guides
  • User tutorials
  • Developer onboarding

🧪 Testing

Running Tests

```bash

Run all tests

npm test

Run tests in watch mode

npm run test:watch

Run E2E tests

npm run test:e2e ```

Test Requirements

  • Unit tests for all utility functions
  • Integration tests for API endpoints
  • E2E tests for critical user flows
  • Accessibility testing with screen readers

📖 Documentation

Code Documentation

  • Use JSDoc for function documentation
  • Include examples in complex functions
  • Document API endpoints with OpenAPI/Swagger
  • Keep README files updated

Commit Messages

Follow conventional commits format: ``` type(scope): description

feat(api): add sign language interpretation endpoint fix(ui): resolve mobile navigation issue docs(readme): update installation instructions ```

🔒 Security

Reporting Security Issues

  • DO NOT create public issues for security vulnerabilities
  • Email security concerns to: security@signlanguageai.com
  • Include detailed reproduction steps
  • Allow time for investigation before disclosure

Security Guidelines

  • Never commit API keys or secrets
  • Use environment variables for configuration
  • Validate all user inputs
  • Follow OWASP security guidelines

🌍 Accessibility Guidelines

Requirements

  • WCAG 2.1 AA compliance minimum
  • Keyboard navigation support
  • Screen reader compatibility
  • High contrast mode support
  • Reduced motion preferences

Testing

  • Test with multiple screen readers (NVDA, JAWS, VoiceOver)
  • Verify keyboard-only navigation
  • Check color contrast ratios
  • Test with accessibility browser extensions

📞 Getting Help

Community Support

  • GitHub Discussions for general questions
  • Discord server: Join our community
  • Stack Overflow tag: `pinky-ai-projects`

Direct Contact

🏆 Recognition

Contributors will be recognized in:

  • README.md contributors section
  • Release notes for significant contributions
  • Annual contributor spotlight
  • Conference speaking opportunities

📄 License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make AI more accessible! 🙏