Contribution Guide
Help us build the future of Web3 engagement. Whether you're fixing bugs, adding features, or improving documentation, every contribution matters.
Getting Started
Thank you for considering contributing to Actora! This guide will walk you through the entire contribution process.
Code Contributions
Bug fixes, new features, performance improvements
Documentation
Guides, tutorials, API documentation, examples
Bug Reports
Help us identify and fix issues faster
Fork & Clone
First, you'll need to fork the repository and clone it to your local machine.
Fork the Repository
Visit the Actora repository on GitHub and click the 'Fork' button in the top right corner.
# Visit: https://github.com/ActoraLabs/actora-sdkClone Your Fork
Clone your forked repository to your local machine using Git.
git clone https://github.com/YOUR_USERNAME/actora-sdk.git
cd actora-sdkAdd Upstream Remote
Add the original repository as an upstream remote.
git remote add upstream https://github.com/ActoraLabs/actora-sdk.git
git fetch upstreamDevelopment Setup
Set up your development environment to start contributing.
Install Dependencies
Install all required dependencies using your package manager.
npm install
# or
yarn installCreate a Branch
Always create a new branch for your changes.
git checkout -b feature/your-feature-nameRun Tests
Make sure all tests pass before making changes.
npm testStart Development Server
Start the dev server to see your changes in real-time.
npm run devCoding Guidelines
Follow these guidelines to ensure your contributions meet our standards.
Code Style
Maintain consistent code style throughout the project.
- Use TypeScript for type safety
- Follow ESLint rules
- Write descriptive variable names
- Keep functions small
- Add comments for complex logic
Testing
Ensure your code is well-tested and reliable.
- Write unit tests for new features
- Maintain test coverage above 80%
- Test edge cases
- Update existing tests if needed
- Run all tests before committing
Documentation
Document your code for other developers.
- Add JSDoc comments
- Update README if needed
- Document breaking changes
- Include usage examples
- Keep docs up-to-date
Commit Messages
Write clear and descriptive commit messages.
- Use conventional commits format
- Start with type: feat, fix, docs
- Keep first line under 50 chars
- Add detailed body if needed
- Reference issue numbers
Pro Tip
Use npm run lint and npm run format before committing to ensure your code meets our style guidelines.
Submit a Pull Request
Ready to submit your contribution? Follow these steps.
Commit Your Changes
Commit your changes with a clear and descriptive message.
git add .
git commit -m "feat: add new feature description"Push to Your Fork
Push your branch to your forked repository on GitHub.
git push origin feature/your-feature-nameCreate Pull Request
Go to the original repository and create a pull request from your branch.
Address Feedback
Our team will review your PR. Address any feedback and push updates.
PR Checklist
- All tests pass
- Code is properly formatted
- Documentation is updated
- Commit messages follow conventions
Join Our Community
Connect with other contributors and get help when you need it.
Contributor Recognition
We value every contribution and recognize our amazing community members
Top Contributors
Featured on our website and README
Exclusive Perks
Early access to new features
Community Shoutouts
Recognition in newsletter
Code of Conduct
We are committed to providing a welcoming community for all.
Need Help?
Additional resources to help you contribute successfully
Ready to Contribute?
Join hundreds of developers building the future of Web3 engagement. Your contribution makes a difference.