57 lines
1.6 KiB
Markdown
57 lines
1.6 KiB
Markdown
# Contributing to SGO
|
|
|
|
Thank you for your interest in contributing to the Security Groups Observatory (SGO)!
|
|
|
|
## License Considerations
|
|
|
|
Before contributing, please note that this project uses a dual-license model:
|
|
- FREE for personal, educational, and non-commercial use
|
|
- PAID license required for commercial use
|
|
|
|
By contributing to this project, you agree that your contributions will be licensed under the same terms.
|
|
|
|
## How to Contribute
|
|
|
|
### Reporting Bugs
|
|
|
|
If you find a bug, please open an issue with:
|
|
- A clear description of the problem
|
|
- Steps to reproduce
|
|
- Expected vs actual behavior
|
|
- Your environment (OS, Docker/Podman version, etc.)
|
|
|
|
### Suggesting Features
|
|
|
|
Feature requests are welcome! Please open an issue describing:
|
|
- The problem you're trying to solve
|
|
- Your proposed solution
|
|
- Any alternatives you've considered
|
|
|
|
### Pull Requests
|
|
|
|
1. Fork the repository
|
|
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
|
3. Make your changes
|
|
4. Test thoroughly with both Docker and Podman
|
|
5. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
6. Push to your branch (`git push origin feature/amazing-feature`)
|
|
7. Open a Pull Request
|
|
|
|
### Code Style
|
|
|
|
- Use comments starting with `#` (no multiline comment markers)
|
|
- Keep code clean and well-documented
|
|
- Follow existing patterns in the codebase
|
|
|
|
### Testing
|
|
|
|
Before submitting a PR, please test:
|
|
- Docker functionality: `docker-compose up --build`
|
|
- Podman functionality: `podman-compose up --build`
|
|
- Both Docker volume and local directory modes
|
|
- CSV export features
|
|
- AWS credential handling
|
|
|
|
## Questions?
|
|
|
|
Feel free to open an issue for any questions about contributing!
|