Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.39 KB

Contributing Guidelines

We welcome and appreciate contributions to this project. By contributing, you help make this toolkit more robust and useful for the community.

How to Contribute

  1. Fork the Repository:
    Create your own fork of the repository on GitHub.

  2. Create a Branch: Create a feature branch for your changes:

    git checkout -b feature/your-feature-name

  3. Make Your Changes:

    • Follow secure coding practices.
    • Ensure code is wel-commented and easy to understand.
    • Keep commits small and focused.

  4. Run Tests and Audits: If applicable, run any test suites (unit tests, lint checks) before pushing your changes.

  5. Submit a Pull Request (PR): Open a PR against the main branch. Include a clear, detailed description of what you changed and why.

Code Standards

  • **Bash Scripting+*: Follow POSIX standards as much as possible, ensure all scripts are tested on bash shell.
  • Security: Do not hard-code credentials. Do not commit secret keys or tokens.
  • Style: Use descriptive variable and function names.
  • Documentation: Update README.md or other relevant documentation if your changes impact usage.

Communication

Please use issues for reporting bugs or requesting features. For questions and general discussion, feel free to opene a discussion on the repository or reach out through the provided channels.