Skip to content

Latest commit

 

History

History
107 lines (74 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

107 lines (74 loc) · 2.71 KB

Contributing to Environment Realism Toolkit

Thanks for your interest in improving this toolkit! Here's how you can help.

How to Contribute

Found a Bug or Have a Suggestion?

Open a GitHub issue with:

  • Clear description of the problem or suggestion
  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Your environment details (OS, tool versions)

Want to Add a Feature?

Before writing code:

  1. Open an issue describing what you want to add
  2. Wait for feedback to ensure it fits the project goals
  3. Fork the repo and create a feature branch
  4. Submit a pull request

Improving Documentation

Documentation improvements are always welcome! This includes:

  • Fixing typos or unclear explanations
  • Adding more examples
  • Improving the quick start guide
  • Translating to other languages

Just submit a PR with your changes.

Pull Request Guidelines

Before Submitting

  • Test your changes thoroughly
  • Update documentation if needed
  • Follow the existing code style
  • Keep changes focused (one feature/fix per PR)

PR Description Should Include

  • What problem does this solve?
  • How does it solve it?
  • Any breaking changes?
  • Screenshots/examples if relevant

Code Style

  • Python: Follow PEP 8
  • Bash: Use shellcheck for validation
  • Markdown: Keep lines under 100 characters when possible
  • Comments: Explain "why", not "what"

Security Vulnerabilities

Do not open public issues for security vulnerabilities.

Instead, email: contactabhishekdatta@gmail.com

Include:

  • Description of the vulnerability
  • Steps to reproduce
  • Potential impact
  • Suggested fix (if you have one)

We'll respond within 7-14 Days and work with you on a fix.

What We're Looking For

High Priority

  • More realistic mock examples (databases, message queues, caches)
  • Scripts to automate common gap checks
  • Real-world audit examples (anonymized)
  • Templates for specific tech stacks (Kubernetes, AWS, etc.)

Medium Priority

  • Translations to other languages
  • Integration with chaos tools (LitmusChaos, Chaos Toolkit)
  • CI/CD integration examples
  • Metrics collection and analysis

Not a Good Fit

  • Highly specific configurations (better in your own fork)
  • Tools that require paid services
  • Overly complex automation (keep it simple)
  • Features that encourage unsafe practices

Code of Conduct

Be respectful and professional. This is a learning community.

  • Assume good intent
  • Provide constructive feedback
  • Help newcomers
  • No harassment, discrimination, or trolling

Violations will result in removal from the project.

Questions?

Open a GitHub Discussion or issue. We're here to help.

License

By contributing, you agree that your contributions will be licensed under the MIT License.