We welcome all contributions to CTFTool! This document will guide you through the process of contributing to this project.
If you encounter a bug, please create an issue in our GitHub repository. Be sure to include:
- A clear and descriptive title
- Exact steps to reproduce the bug
- Expected and actual behavior
- Screenshots or animated GIFs, if applicable
We're always open to suggestions for improvements or new features. To suggest an enhancement:
- Open a new issue with a clear and descriptive title
- Provide a detailed description of the enhancement
- Explain why this enhancement would be useful to CTFTool users
Ready to contribute code? Follow these steps:
- Fork the repo and create your branch from
main. - Implement your changes and test them out.
- If you've added code, make sure to add corresponding tests.
- Ensure the test suite passes.
- Issue that pull request!
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or fewer.
- Reference issues and pull requests liberally after the first line.
All Go code must adhere to effective Go coding standards.
Thank you for your interest in contributing to CTFTool!