🤝 Open Source Community

Contribute to
Holesail

Join our open source community and help shape the future of P2P networking. Every contribution, big or small, makes a difference.

View on GitHub Join Keet.io Join Discord

Ways to Contribute

There are many ways to contribute to Holesail, regardless of your skill level

Report Issues

Help us improve by reporting bugs, issues, or unexpected behavior you encounter.

Search existing issues first
Provide detailed reproduction steps
Include system information
Add logs or screenshots

Report Issue

Suggest Features

Share your ideas for new features or improvements to existing functionality.

Describe the use case clearly
Explain expected behavior
Consider implementation impact
Engage with community feedback

Suggest Feature

Submit Code

Contribute code improvements, bug fixes, or new features to the project.

Fork the repository
Create a feature branch
Write tests for changes
Submit a pull request

View Pull Requests

Improve Documentation

Help make our documentation clearer, more comprehensive, and easier to understand.

Fix typos and grammar
Add missing examples
Improve clarity
Translate content

Edit Documentation

Help Others

Support other community members by answering questions and sharing knowledge.

Answer questions on Discord
Help with GitHub issues
Share your experience
Mentor newcomers

Join Community

Spread the Word

Help grow our community by sharing Holesail with others who might benefit.

Star us on GitHub
Share on social media
Write blog posts
Give talks or demos

Star on GitHub

Getting Started

Follow these steps to make your first contribution

Set Up Your Environment

Fork the repository and set up your local development environment

Fork the Holesail repository on GitHub
Clone your fork locally
Install Node.js and npm dependencies
Run the test suite to ensure everything works

Find an Issue

Look for issues labeled 'good first issue' or 'help wanted'

Browse the GitHub issues page
Look for beginner-friendly labels
Read the issue description carefully
Ask questions if anything is unclear

Make Your Changes

Create a branch and implement your solution

Create a new branch for your feature
Write clean, well-documented code
Add tests for your changes
Follow our coding standards

Submit Your Pull Request

Open a pull request and get feedback from maintainers

Push your changes to your fork
Open a pull request with a clear description
Respond to feedback promptly
Make requested changes if needed

Development Guidelines

Follow these guidelines to ensure your contributions are accepted

Code Standards

•Follow existing code style and conventions
•Write clear, self-documenting code
•Add comments for complex logic
•Use meaningful variable and function names
•Keep functions small and focused

Testing Requirements

•Write unit tests for new functionality
•Ensure all tests pass before submitting
•Maintain or improve code coverage
•Test edge cases and error conditions
•Update integration tests if needed

Pull Request Guidelines

•Create focused, single-purpose PRs
•Write clear commit messages
•Include a detailed PR description
•Link to related issues
•Be responsive to feedback

Documentation

•Update documentation for new features
•Include code examples where helpful
•Update API documentation
•Fix typos and improve clarity
•Keep README files up to date

Recognition

We appreciate all contributions and recognize our community members

Contributors Hall of Fame

Your contributions will be featured on this website and the GitHub repository.

Ready to Contribute?

Join our community of contributors and help build the future of P2P networking.