diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..527e9efc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** + + + +**To Reproduce** + +Steps to reproduce the behavior: + +* Step1 +* Step2 +* ... + +**Expected behavior** + + +**Screenshots** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..ad9a01dd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** + + +**Describe the solution you'd like** + + +**Describe alternatives you've considered** + + +**Additional context** + diff --git a/.github/issue_template.md b/.github/ISSUE_TEMPLATE/general_issue.md similarity index 99% rename from .github/issue_template.md rename to .github/ISSUE_TEMPLATE/general_issue.md index b677e12b..0048f4fc 100644 --- a/.github/issue_template.md +++ b/.github/ISSUE_TEMPLATE/general_issue.md @@ -6,4 +6,3 @@ Describe your issue here. A description of the problem you're trying to solve. ### Mention expected Result or Output of your issue: ### Mention language you want to work on: - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9a3fce7f..d4195de6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,25 @@ ### Your checklist for this pull request -🚨Please review the [guidelines for contributing](https://github.com/sanscript-tech/hacking-tools-scripts/blob/main/CONTRIBUTING.md) to this repository.

+:warning: Please review the [guidelines for contributing](https://github.com/sanscript-tech/hacking-tools-scripts/blob/main/CONTRIBUTING.md) to this repository. -Parent issue: #("mention issue no.")
+Parent issue: #("mention issue no.") ### Type of change -Select all that applies:
-[ ]New feature (non-breaking change which adds functionality)
-[ ]Bug fix (non-breaking change which fixes an issue)
-[ ]Breaking change (fix or feature that would cause existing functionality to not work as expected)
-[ ]This change requires a documentation update
+**Select all that applies**: +* [ ] New feature (non-breaking change which adds functionality) +* [ ] Bug fix (non-breaking change which fixes an issue) +* [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +* [ ] This change requires a documentation update ### Checklist: -[ ]My code follows the style guidelines(Clean Code) of this project
-[ ]I have performed a self-review of my own code
-[ ]I have used consistent code conventions and clear function/method/variable names
-[ ]I have commented on my code, particularly in hard-to-understand areas
-[ ]I have created a helpful and easy to understand README.md which contains description, requirements and use case.
-[ ]I have added relevent screenshots if necessary
-[ ]I have made corresponding changes to the documentation
-[ ]My changes generate no new warnings
+* [ ] My code follows the style guidelines(Clean Code) of this project. +* [ ] I have performed a self-review of my own code. +* [ ] I have used consistent code conventions and clear function/method/variable names. +* [ ] I have commented on my code, particularly in hard-to-understand areas. +* [ ] I have created a helpful and easy to understand README.md which contains description, requirements and use case. +* [ ] I have added relevent screenshots if necessary. +* [ ] I have made corresponding changes to the documentation. +* [ ] My changes generate no new warnings. -### πŸ’”Thank you! +### :heart: Thank you! diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 40802168..1c373b59 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -72,7 +72,7 @@ reporter of any incident. Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: -### 1. Correction +1. ### Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. @@ -81,7 +81,7 @@ unprofessional or unwelcome in the community. clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. -### 2. Warning +2. ### Warning **Community Impact**: A violation through a single incident or series of actions. @@ -93,7 +93,7 @@ includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. -### 3. Temporary Ban +3. ### Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. @@ -104,7 +104,7 @@ private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. -### 4. Permanent Ban +4. ### Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an @@ -115,6 +115,4 @@ the community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.0, available at -https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) version 2.0. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 538f9273..06efb43e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,13 +35,13 @@ _The Event will end on **20 November 2020**. We will provide a **certificate** of contribution to the participant with at least **one pull request merged.**_ -**Mentors/Maintainers of the project:-** -- @tejan-singh -- @yashaswibiyahut -- @balapriyac +**Mentors/Maintainers of the project:-** +- @tejan-singh +- @yashaswibiyahut +- @balapriyac - @SANKET7738 -**_For queries regarding registration, participation, certification and rewards, reach out for help at_ +**_For queries regarding registration, participation, certification and rewards, reach out for help at_ help@sanscript.tech** ## Fork this repository πŸš€ @@ -49,17 +49,17 @@ help@sanscript.tech** Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account. - +![forking](https://user-images.githubusercontent.com/56690856/96425111-453c6380-1219-11eb-80f4-f46a0371ed2e.png) ## Clone the repository 🏁 Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon. - +![cloning](https://user-images.githubusercontent.com/56690856/96425484-b24ff900-1219-11eb-9cf0-58053ee8b758.png) Open a terminal and run the following git command: -``` +```bash git clone "url you just copied" ``` @@ -67,80 +67,80 @@ where "url you just copied" (without the quotation marks) is the url to this rep For example: -``` +```bash git clone https://github.com/sanscript-tech/hacking-tools-scripts ``` - +![cloning to local](https://user-images.githubusercontent.com/56690856/96425961-3ace9980-121a-11eb-8516-8235782e86f9.png) ## Create a branch βš“ Change to the repository directory on your computer (if you are not already there): -``` +```bash cd (filename) ``` - +![set working directory](https://user-images.githubusercontent.com/56690856/96426111-6ea9bf00-121a-11eb-90e3-8ccc7183a6c0.png) Now create a branch using the `git checkout` command: -``` +```bash git checkout -b your-new-branch-name ``` For example: -``` +```bash git checkout -b dev_username ``` - +![checking out to new branch](https://user-images.githubusercontent.com/56690856/96426659-2a6aee80-121b-11eb-81f3-d616ae00229d.png) ## Make necessary changes and commit those changes 🚏 Do the necessary changes. If you go to the project directory and execute the command `git status`, you'll see there are changes. - +![making changes](https://user-images.githubusercontent.com/56690856/96426834-6736e580-121b-11eb-9211-8b26715921ae.png) Add those changes to the branch you just created using the `git add` command: -``` +```bash git add . ``` - +![add changes](https://user-images.githubusercontent.com/56690856/96427459-34412180-121c-11eb-9fa1-72cdaeae61f3.png) Now commit those changes using the `git commit` command: -``` +```bash git commit -m "(Add your message here)" ``` replacing `` with your message. - +![commit changes](https://user-images.githubusercontent.com/56690856/96427464-35724e80-121c-11eb-91c2-20001f5def5a.png) ## Push changes to GitHub πŸͺ‚ Push your changes using the command `git push`: -``` +```bash git push origin ``` replacing `` with the name of the branch you created earlier. - +![push changes](https://user-images.githubusercontent.com/56690856/96427466-360ae500-121c-11eb-9c02-e201906a0a72.png) ## Submit your changes for review 🚩 If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button. - +![create PR](https://user-images.githubusercontent.com/56690856/96427945-ce08ce80-121c-11eb-9223-a120c7d72541.png) Now submit the pull request. -

+![submit PR](https://user-images.githubusercontent.com/56690856/96427954-cfd29200-121c-11eb-90f7-1f4ea2f8342f.png) Soon we will be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged. diff --git a/README.md b/README.md index 18b28c9c..2bc35d56 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,6 @@ [![forthebadge](https://forthebadge.com/images/badges/thats-how-they-get-you.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/powered-by-black-magic.svg)](https://forthebadge.com) -
- [![GitHub issues](https://img.shields.io/github/issues/sanscript-tech/hacking-tools-scripts?style=flat-square)](https://github.com/sanscript-tech/hacking-tools-scripts/issues) [![GitHub forks](https://img.shields.io/github/forks/sanscript-tech/hacking-tools-scripts?style=flat-square)](https://github.com/sanscript-tech/hacking-tools-scripts/network) ![GitHub pull requests](https://img.shields.io/github/issues-pr/sanscript-tech/hacking-tools-scripts?color=green&style=flat-square) @@ -32,18 +30,18 @@ Collection of awesome scripts and hacking tools from basic to advance. Contribut

Logo -## Overview +## Overview This project is mainly ensured to build in an open source community to help the people of our country grow and develop themselves. - -## Tech stacks used + +## Tech stacks used **Any Scripting Language** ## How to participate and contribute? -### Register as a participant on [**Sanscript India**](https://sanscript.tech) website and start contributing.***(Registrations are Open!!)***
-### Follow contribution guidelines mentioned [here.](https://github.com/sanscript-tech/hacking-tools-scripts/blob/main/CONTRIBUTING.md)
-### Contributions will end on ***20 November 2020***. - +* Register as a participant on [**Sanscript India**](https://sanscript.tech) website and start contributing. ***Registrations are Open!!*** +* Follow contribution guidelines mentioned [here.](https://github.com/sanscript-tech/hacking-tools-scripts/blob/main/CONTRIBUTING.md) +* Contributions will end on ***20 November 2020***. + ### This project is under AOS 2020 (Autumn open source program) under Sanscript, India.