Contributing
Like other open source projects, there are many ways to contribute to bettercap. Contributions welcome from both developers and users.
The amazing people that helped improve bettercap:
Improving the Documentation
Section titled “Improving the Documentation”You can improve this documentation by forking its repository, updating the contents and sending a pull request.
Reporting Bugs
Section titled “Reporting Bugs”Found a bug or inconsistency? Create an Issue using the GitHub Issue tracker, but first make sure:
- You read this documentation.
- You are using the latest stable version of bettercap.
- You already searched other issues to see if your problem or request was already reported.
Once you’ve checked the list, open an issue with these details:
- bettercap version you are using (
bettercap -version). - Go version if building from sources.
- OS version and architecture you are using.
- Command line arguments you are using.
- Caplet code you are using or the interactive session commands.
- Full debug output while reproducing the issue (
bettercap -debug ...). - The steps to reproduce the bug.
Sending a Pull Request
Section titled “Sending a Pull Request”Know Go and have ideas to improve bettercap? Send us pull requests! We’ll merge them when they follow these rules:
- You have at least manually tested your code, ideally you’ve created actual tests for it.
- Respect our coding standard, 2 spaces indentation and modular code.
- There’re no conflicts with the current master branch.
- Your commit messages are enough explanatory to us.
Ways to improve bettercap:
- Implement a new session module (in Go).
- Implement a new proxy module (in JavaScript).
- Implement a new caplet.
- Fix, extend or improve the core.