Skip to content

Guide for adding a new script to the repository

Mahdi Qiamast edited this page Feb 5, 2023 · 1 revision

Guide for Adding a New Script

1. Fork the Repository

Fork the repository to your own GitHub account by clicking the "Fork" button in the top right corner of the repository page.

2. Clone the Repository

Clone the repository to your local machine using the following command:

git clone https://github.com/Qiamast/Bash-Tricks.git

3. Create a New Directory

Create a new directory for your script, following the naming convention script_<task>_<number>, for example, script_automation_2. Place your script and any necessary files in this directory.

4. Write a README

Create a README file for your script in the same directory, explaining what the script does, how to use it, and any dependencies it may have. Be sure to include clear and concise information so that others can easily understand and use your script.

5. Commit and Push

Commit your changes and push them to your fork using the following commands:

git add .
git commit -m "Add script for <task>"
git push origin master

6. Submit a Pull Request

Submit a pull request from your fork to the main repository, detailing your changes and why you think your script should be included in the collection. The repository maintainers will review your changes and provide feedback or merge the request if appropriate.

Note

Please ensure that your script follows the repository's coding standards and conventions. It should be well-documented and tested before submission.