CONTRIBUTING.md

Contributing to WALLIX Bastion Splunk Add-on

Thank you for your interest in contributing to the WALLIX Bastion Technology Add-on for Splunk!

We welcome contributions from the community to improve features, fix bugs, and enhance documentation. Please follow these guidelines to ensure a smooth collaboration process.

How to Contribute

1. Fork the repository
   • Click the "Fork" button at the top right of the GitHub page.
2. Clone your fork
   • git clone https://github.com/<your-username>/Splunk-add-on.git
3. Create a new branch
   • git checkout -b feature/my-feature
4. Make your changes
   • Follow the coding standards and add tests if possible.
5. Commit your changes
   • git commit -m "Describe your change"
6. Push your branch
   • git push origin feature/my-feature
7. Open a Pull Request
   • Go to your fork on GitHub and click "Compare & pull request".

Code Style & Standards

• Use clear, descriptive commit messages.
• Follow Python best practices (PEP8).
• Add comments and documentation for new features.
• Test your code before submitting.
• Ensure compatibility with Splunk Enterprise 7.0+ and Splunk Cloud.

Reporting Issues

If you find a bug or have a feature request:

• Open an issue on GitHub with a clear description and steps to reproduce.
• Attach logs, screenshots, or configuration files if relevant.

Pull Request Checklist

Before submitting a pull request:

• The code builds and passes tests.
• The code is formatted and linted.
• Documentation is updated if needed.
• The PR description explains the purpose and changes.

Code of Conduct

Please be respectful and constructive in all interactions. We follow the Contributor Covenant.

License

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

---

Thank you for helping improve the WALLIX Bastion Splunk Add-on!