diff --git a/.github/ISSUE_TEMPLATE/bug-doc.yml b/.github/ISSUE_TEMPLATE/bug-doc.yml index 4f03fab..bd944c1 100644 --- a/.github/ISSUE_TEMPLATE/bug-doc.yml +++ b/.github/ISSUE_TEMPLATE/bug-doc.yml @@ -1,9 +1,9 @@ name: ๐Ÿ‘พ Report Mistakes in Documentation -description: Help us to build a better guidelines for you +description: Help us to build a better guideline for you. labels: [bug] assignees: eshanized body: - + - type: checkboxes attributes: label: Have you read the Contributing Guidelines? @@ -21,21 +21,24 @@ body: - type: dropdown attributes: - label: What Type of Mistake we made? - description: You can select more than one options. + label: What Type of Mistake We Made? + description: You can select more than one option. multiple: true options: - Spelling Mistake - Wrong Documentation or Code Not Working - Incomplete Documentation + - Incorrect Instructions + - Outdated Information + - Other (please specify) validations: required: true - type: textarea attributes: label: Write the correction - description: It is not necessary to write here. You can directly edit the [documentation](https://github.com/Snigdha-OS/documentation/tree/master/docs) repository and create pull request. - placeholder: e.g L10 to L12 "Wite down your correction or edit the code directly." + description: It is not necessary to write here. You can directly edit the [documentation](https://github.com/Snigdha-OS/documentation/tree/master/docs) repository and create a pull request. + placeholder: e.g L10 to L12 "Write down your correction or edit the code directly." validations: required: false @@ -43,7 +46,7 @@ body: attributes: label: Your PC Specification description: | - Include as many relevant details about the environment you experienced the bug in. + Include as many relevant details about the environment where you experienced the issue. > run `cat /etc/os-release` on terminal to see **OS Build ID** value: | - CPU: [e.g i5 1335U] @@ -51,12 +54,70 @@ body: - STORAGE: [e.g SSD/HDD] - Snigdha OS Build: [e.g arctic] - Snigdha OS Version: [e.g 4.5] + - OS: [e.g Ubuntu 20.04] + - Kernel: [e.g 5.4.0-80-generic] + - Architecture: [e.g x86_64] - type: checkboxes attributes: label: Self-service description: | - If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it. - If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else. + If you feel like you could contribute to fixing this issue, please check the box below. This will notify us and others looking for contributions that someone's working on it. + If you check this box, please send a pull request within 7 days so we can delegate this to someone else if necessary. options: - label: I'd be willing to fix this bug myself. + required: false + + - type: input + attributes: + label: Estimated Time to Fix + description: Please provide an estimate on how long you think it will take to fix the issue. + placeholder: e.g 1-2 hours + validations: + required: false + + - type: textarea + attributes: + label: Additional Comments + description: | + If you have any additional comments or insights about the documentation issue, feel free to share. + This can include details about possible improvements or potential fixes. + placeholder: e.g "The page layout might be improved for clarity." + validations: + required: false + + - type: input + attributes: + label: Your GitHub Username + description: If you'd like us to acknowledge your contribution, provide your GitHub username. + placeholder: e.g johndoe + validations: + required: false + + - type: checkboxes + attributes: + label: Acknowledge Self-Resolution + description: | + If you resolve this issue yourself by submitting a PR, kindly acknowledge the resolution. + options: + - label: I will submit a pull request to fix this issue. + required: false + + - type: dropdown + attributes: + label: Is This Issue Related to Translation? + description: If the documentation mistake is related to translation, select "Yes" and provide details. + options: + - label: Yes + - label: No + validations: + required: false + + - type: textarea + attributes: + label: Translation Details (if applicable) + description: | + If the issue is related to translation (e.g. wrong or missing translations), please provide details and the language in which the translation error occurred. + placeholder: e.g "In Spanish translation, the word 'install' is missing from the instructions on page X." + validations: + required: false diff --git a/push.sh b/push.sh index c3260b5..09746d7 100755 --- a/push.sh +++ b/push.sh @@ -1,7 +1,86 @@ #!/bin/bash -# Author : Eshan Roy +# Author : ESHAN ROY +# Author URI : https://eshanized.github.io +# Define the conventional commit types with new emojis +TYPES=("๐Ÿš€ feat" "๐Ÿ› fix" "๐Ÿ“ docs" "โœจ style" "๐Ÿ›  refactor" "โšก๏ธ perf" "๐Ÿ”ฌ test" "๐Ÿ”ง build" "๐Ÿค– ci" "๐Ÿงน chore" "โช revert") + +# Function to display an error and exit and +error_exit() { + echo -e "\033[1;31m[ERROR]\033[0m $1" + exit 1 +} + +# Ensure the script is run in a Git repository +git rev-parse --is-inside-work-tree > /dev/null 2>&1 || error_exit "This is not a Git repository." + +# Get the current branch name +branch=$(git rev-parse --abbrev-ref HEAD) + +# Pull the latest changes from the remote repository +echo "Pulling latest changes from remote branch '$branch'..." +git pull origin "$branch" || error_exit "Failed to pull changes from the remote repository. Please resolve any conflicts manually." + +# Prompt the user to select a commit type +echo "Select a commit type:" +select type in "${TYPES[@]}"; do + if [[ -n "$type" ]]; then + break + else + echo "Invalid selection. Please try again." + fi +done + +# Extract the commit type and emoji from the selection +type_emoji=${type} +type=${type_emoji#* } +emoji=${type_emoji% *} + +# Prompt the user to enter a scope (optional) +read -p "Enter a scope (optional): " scope +scope_part="" +if [ -n "$scope" ]; then + scope_part="($scope)" +fi + +# Prompt the user to enter a short description +read -p "Enter a short description: " desc +if [ -z "$desc" ]; then + error_exit "A short description is required!" +fi + +# Prompt the user to enter a longer description (optional) +read -p "Enter a longer description (optional): " long_desc + +# Create the commit message +commit_msg="$emoji $type$scope_part: $desc" + +# If a longer description was provided, add it to the commit message +if [ -n "$long_desc" ]; then + commit_msg+=" + +$long_desc" +fi + +# Print the commit message to the console +echo -e "\nCommit message:" +echo -e "\033[1;36m$commit_msg\033[0m" + +# Stage all changes git add . -git commit -m "โ›๏ธ@eshanized updating..." -git push origin master \ No newline at end of file + +# Commit the changes with the conventional commit message +if git commit -m "$commit_msg"; then + echo -e "\033[1;32mCommit successful!\033[0m" +else + error_exit "Commit failed." +fi + +# Push the changes to the remote repository +echo "Pushing changes to remote branch '$branch'..." +if git push origin "$branch"; then + echo -e "\033[1;32mChanges pushed to remote branch '$branch'.\033[0m" +else + error_exit "Push failed. Please check your connection or branch permissions." +fi \ No newline at end of file