Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 2.27 KB

README.md

File metadata and controls

58 lines (45 loc) · 2.27 KB
Raw

PolyScripts

Welcome to PolyScripts! This is a diverse collection of useful scripts across various programming languages. Our goal is to build a comprehensive repository of scripts that cater to different needs and technologies.

Folder Structure

This repository is organized into the following folders:

  • Bash/: Scripts written in Bash. [Example is in Desktop_Time_Tracker foler]
  • Go/: Scripts written in Go (Golang). [Example is in Bitcoin_Price_Tracker folder ]
  • JavaScript/: Scripts written in JavaScript.
  • Python/: Scripts written in Python.

How to Contribute

We welcome contributions from developers of all levels! To contribute a script, please follow these steps:

  1. Fork the Repository: Click the "Fork" button on the top-right corner of this page.

  2. Clone Your Fork:

    git clone https://github.com/<your-username>/PolyScripts.git

  3. Create a New Branch:

    git checkout -b my-feature-branch

  4. Add Your Script: Create a new file or folder in the appropriate language directory and add your script.

  5. Include Documentation:

    • Create a README.md: For each script or set of scripts you add, please include a README.md file in the same directory. This file should explain:
      • The purpose of the script(s).
      • How to use the script(s).
      • Any dependencies or setup required.
    • Documentation is Mandatory: Proper documentation is required for all contributions. This helps others understand and use your scripts effectively.

  6. Commit Your Changes:

    git add .
git commit -m "Added my script: [brief description]"

  7. Push Your Changes:

    git push origin my-feature-branch

  8. Submit a Pull Request: Go to the "Pull Requests" tab on GitHub and create a new pull request. Provide a clear description of what you’ve added or changed.

Contribution Guidelines

  • Clean Code: Ensure your code is clean, well-commented, and follows best practices.
  • Testing: Test your scripts to ensure they work as expected.
  • Format: Follow the folder and naming conventions mentioned above.

Questions?

If you have any questions or need help, feel free to open an issue or contact us directly.

Thank you for contributing to PolyScripts!