Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 1.79 KB

File metadata and controls

46 lines (34 loc) · 1.79 KB

Contribution Guidelines

This project is a collection of CI/CD tools/scripts primarily used in closed environments such as local servers. We welcome contributions that help improve these tools and make them more robust.

How to Contribute

  1. Fork the Repository: Create your own fork of this repository
  2. Clone Locally: Clone your fork to your local machine
  3. Make Changes: Implement improvements or fixes to any of the scripts/tools
  4. Test Your Changes: Ensure that your changes work properly in a closed environment context
  5. Document: Write down how to use your tool in the README.md
  6. Submit Pull Request: Open a pull request with your changes

Code Standards

  • Follow shell scripting best practices for bash scripts
  • Maintain consistency with existing code style and formatting
  • Document any new features or modifications clearly
  • Make sure all dependencies are properly handled

Reporting Issues

When reporting issues, please:

  1. Describe the problem clearly
  2. Provide steps to reproduce it
  3. Include relevant environment information (such as OS version)
  4. Mention which script is affected

License

By contributing to this project, you agree that your contributions will be licensed under the same license as the original project.

Additional Notes

Contributions should focus on:

  • Improving existing scripts
  • Adding new useful tools/scripts
  • Enhancing error handling or logging capabilities
  • Optimizing performance or adding features that improve functionality in closed environments

Review Process

All contributions will be reviewed by maintainers before merging, particularly focusing on:

  • Compatibility with the intended closed environment usage
  • Appropriate error reporting and logging mechanisms
  • Backward compatibility considerations

Thank you for contributing to this project!