Linux Script Utility Library

The Linux Script Utility Library is an open-source collection of scripts designed to simplify common tasks for Linux users. We aim to build a robust utility library with contributions from the community, covering automation, system maintenance, and other daily operations.

How to Contribute

We encourage contributions from developers of all skill levels! Whether you're participating in Hacktoberfest or simply looking to enhance the Linux experience, we welcome your ideas and improvements.

Contribution Guidelines

1. Fork the Repository: Start by forking the repo and cloning it to your local machine.

   git clone https://github.com/HackfedCommunity/linux-script-utility-library.git
   cd linux-script-utility-library

2. Work on an Issue or Feature:

   • Check out the issues section for tasks you can work on.
   • If you want to add a new feature, open an issue to discuss your idea first.

3. Create a New Script:

   • Follow the structure of existing scripts under the relevant directory (e.g., bash/, python/).
   • Include detailed comments in your code and write usage instructions.

4. Write Documentation:

   • Add instructions and usage details for your script in the README.md or create a new file under docs/.
   • Ensure the documentation is clear and concise.

5. Submit a Pull Request: Once you're done, create a pull request with details of the changes you made. Ensure the PR follows the contribution guidelines and includes appropriate documentation.

   git add .
   git commit -m "Add new feature/script for..."
   git push origin your-branch-name

   We’ll review your pull request as soon as possible!

What We're Looking For

• Bash/Python Scripts: Utilities for automating system tasks like backups, updates, monitoring, and more.
• Well-Commented Code: Include clear comments to explain what your script does.
• Modular & Reusable: Try to make your script as reusable and customizable as possible.
• Documentation: Clear and concise documentation is crucial for other users to understand and use your script.

If you're contributing as part of Hacktoberfest, ensure your pull requests are aligned with the Hacktoberfest guidelines:

• PRs should be meaningful and add value to the repository.
• Avoid low-quality or spammy contributions.

Hacktoberfest Participation

This repository is participating in Hacktoberfest 2024! Make sure your contributions follow the guidelines below:

• All valid pull requests during Hacktoberfest will be marked with the hacktoberfest-accepted label once they are reviewed and approved.
• Hacktoberfest Rules: PRs must not be spammy and should contribute real value to the project. Avoid "quick wins" with no real benefit.

We are excited to see your contributions!