Skip to main content

Contributing to Crefy Connect

We welcome contributions from the community! Crefy Connect is an open-source project that benefits from your expertise and feedback.

Ways to Contribute

Code Contributions

  • Bug Fixes: Help us identify and fix issues
  • New Features: Implement new functionality and improvements
  • Performance Improvements: Optimize existing code
  • Documentation: Improve docs and examples

Non-Code Contributions

  • Documentation: Write tutorials, guides, and API docs
  • Testing: Help test new features and report bugs
  • Community Support: Help other developers in issues and discussions
  • Feature Requests: Suggest new functionality

Development Workflow

1. Fork and Clone

2. Set Up Development Environment

3. Create a Feature Branch

4. Make Your Changes

  • Follow the existing code style
  • Add tests for new functionality
  • Update documentation
  • Ensure all tests pass

5. Test Your Changes

6. Submit a Pull Request

Then create a Pull Request on GitHub with a clear description of your changes.

Code Standards

TypeScript

  • Use TypeScript for all new code
  • Enable strict type checking
  • Use interfaces for component props and API responses
  • Avoid any types when possible

React Best Practices

  • Use functional components with hooks
  • Follow React naming conventions
  • Keep components small and focused
  • Use proper TypeScript types for props

Naming Conventions

Error Handling

Testing Guidelines

Component Tests

Hook Tests

Documentation

API Documentation

When adding new APIs, create comprehensive documentation:

README Updates

  • Update README.md for new features
  • Add examples in the examples directory
  • Update installation instructions if needed

Community

Communication

  • GitHub Issues: For bug reports and feature requests
  • GitHub Discussions: For general questions and ideas
  • Discord: For real-time community chat

Getting Help

  • Check existing issues and documentation first
  • Provide clear, reproducible examples when reporting bugs
  • Be respectful and constructive in all communications

License

By contributing to Crefy Connect, you agree that your contributions will be licensed under the MIT License.
Thank You: We appreciate all contributions, big and small! Your help makes Crefy Connect better for everyone.