GitHub Automation Scripts 🤖

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

GitHub

Contributing to GitHub-Automation-Scripts

First off, thanks for taking the time to contribute! ❤️

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

Star the project
Tweet about it

Asking Questions

If you want to ask a question, join the 'GitHub Automation scripts' project channel on the GSSoC discord server. To join the project channel, make sure you have the 'GitHub Automation scripts' & 'Contributor' role assigned to you. If you don't have the role assigned to you, you can self-assign it in the #self-roles channel.

Before you ask a question, it is best to search for existing Issues that might help you. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

Provide as much context as you can about what you're running into.

Provide details about your OS and environment.

How To Contribute

Fork the project on GitHub, clone it on your PC.

If you have an idea for an enhancement or a bug, you can first check the Issues to see if your question has been asked before.

If you'd like to work on an issue, please ask the creator of the issue to assign it to you. This helps to keep the workflow streamlined.

Create a new branch for your contribution and make the changes you want to make. (Always check for updates on the main branch before creating a pull request to avoid merge conflicts.)

The pull request should mention the issue it is trying to solve and should be linked to it. Here is a video on how to link PRs to issues - video link.

Make sure to make the appropriate changes in the README.md file if you are adding a new script or feature.

Installation

Requirements:

Git Bash installed on your computer.
GitHub personal access token. (Go to your GitHub profile -> Settings -> Developer settings -> Personal Access Tokens -> Create new token with all the repository permissions)

Note: This script is written exclusively for Git Bash on Windows. You will have to modify it for other shells.

Fork and clone the repository locally.
Create a github_secrets.py file in the ./scripts folder and define the following variables inside it:
```
GITHUB_API_TOKEN = "Your GitHub personal access token"
USERNAME = "Your GitHub username"
```
Add the project path to the PATH variable (Recommended):
```
$ export PATH=$PATH":"$(pwd)"/scripts"
```
To permanently add the scripts path to the PATH variable, run the below command in the project's root directory. (This file is located in your home directory)
```
$ echo 'export PATH=$PATH''":'"$(pwd)"'/scripts''"' >> ~/.bash_profile
```
OR

Run the following commands in the project folder to add the scripts to your bin directory:
```
$ cp -r /scripts/* /usr/bin/
```

How to Use

        create_repo -h

Sample usage:

        create_repo <PATH_NAME> <REPO_NAME>

<PATH_NAME> is the path where you want to create the local repository and <REPO_NAME> is the name for your repo

Example:

        create_repo . test-repo

License

        
    MIT License

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.

About GitHub Automation Scripts

Tech Stack