From 9769df997741a98d57512b10bcab6f146e748f94 Mon Sep 17 00:00:00 2001 From: ayushdhiman-py Date: Tue, 14 Nov 2023 12:25:12 +0530 Subject: [PATCH 1/2] updated README.md --- README.md | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d925c69..a67a15e 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,12 @@ 2. [Architecture](#an-overview-of-the-gfi-web-app-architecture) 3. [Why "GFI"?](#why-gfi) 4. [Contribution Guidelines](#contribution-guidelines) - +4. [Submitting a pull request](#submitting-a-pull-request) +5. [Prerequisites](#prerequisites) +6. [Resources](#resources) ## Description -GitHub advises the usage of "good first issue" (GFI) labels to identify issues that are feasible for newcomers to handle in order to speed up beginner onboarding. However, prior research demonstrates the scarcity and inappropriateness of manually classified GFIs, demonstrating the need for automated suggestions. In this project, we propose GFI-Web-app, a proof-of-concept for automatic GFI recommendation in reality (available at https://pending.com). Project administrators can set up GFI-app to find and tag potential GFIs so that beginners can quickly find issues to fix when submitting their first contributions. - +GitHub advises the usage of "good first issue" (GFI) labels to identify issues that are feasible for newcomers to handle in order to speed up beginner onboarding. However, prior research demonstrates the scarcity and inappropriateness of manually classified GFIs, demonstrating the need for automated suggestions. In this project, we propose GFI-Web-app, a proof-of-concept for automatic GFI recommendation in reality (available at https://pending.com). Project administrators can set up GFI-app to find and tag potential GFIs so that beginners can quickly find issues to fix when submitting their first contributions. ## An Overview of the GFI-Web App Architecture

@@ -23,26 +24,41 @@ This website is primarily intended for developers who wish to contribute to open ## Contribution Guidelines -_Welcome hackers it is really **awesome** have you here! Before start contributing with this project make sure you read our [Code Of Conduct](https://github.com/clubgamma/Good_First_Issue_Web_App/blob/main/CODE_OF_CONDUCT.md), it is really important to make this inclusive and open to everyone, otherwise, it would not be awesome to have you here_ +_Welcome hackers! It is really awesome to have you here! Before start contributing to this project, make sure you read our [Code Of Conduct](https://github.com/clubgamma/Good_First_Issue_Web_App/blob/main/CODE_OF_CONDUCT.md). It is crucial to make this inclusive and open to everyone; otherwise, it would not be awesome to have you here._ ## Submitting a pull request 1. [Fork](https://github.com/clubgamma/Good_First_Issue_Web_App/fork) and clone the repository 2. Create a new branch: `git checkout -b my-branch-name` 3. Add a file with your name in the contributions folder telling about your contributions and also link that file in the readme -5. Push to your fork and [submit a pull request](https://github.com/clubgamma/Good_First_Issue_Web_App/compare) -6. Pat your self on the back and wait for your pull request to be reviewed and merged. +4. Push to your fork and [submit a pull request](https://github.com/clubgamma/Good_First_Issue_Web_App/compare) +5. Pat yourself on the back and wait for your pull request to be reviewed and merged. + +### Prerequisites +Before you start contributing to the GFI-Web-App frontend project, ensure that you have the following tools and dependencies installed on your machine: + +- **Node.js and npm:** Make sure you have Node.js installed on your machine. You can download it from [https://nodejs.org/](https://nodejs.org/). npm will be installed automatically with Node.js. + +- **Git:** Version control is essential for collaborative development. Install Git from [https://git-scm.com/](https://git-scm.com/). -### Resources +- **Code Editor or IDE:** Choose a code editor or integrated development environment (IDE) of your preference. Popular choices include Visual Studio Code, Sublime Text, or Atom. +- **Web Browser:** Have a modern web browser installed, such as Google Chrome, Mozilla Firefox, or Microsoft Edge. + +- **Project-specific dependencies:** The project relies on specific Node.js packages. You can install them by navigating to the project directory in the terminal and running the command: + + ```bash + npm install + + +## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) - [GitHub Help](https://help.github.com) -## Want to Contribute to more awesome Hacktoberfest repository? - -**Hacktoberfest repository :** +## Want to Contribute to more awesome Hacktoberfest repositories? +**Hacktoberfest repository:** | **Repositories** | **URL** | | --- |--- | From b461f2910ae49d0eee80ff45d943b164116b6014 Mon Sep 17 00:00:00 2001 From: ayushdhiman-py Date: Tue, 14 Nov 2023 12:29:51 +0530 Subject: [PATCH 2/2] updated README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a67a15e..c96d3e1 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ This website is primarily intended for developers who wish to contribute to open ## Contribution Guidelines _Welcome hackers! It is really awesome to have you here! Before start contributing to this project, make sure you read our [Code Of Conduct](https://github.com/clubgamma/Good_First_Issue_Web_App/blob/main/CODE_OF_CONDUCT.md). It is crucial to make this inclusive and open to everyone; otherwise, it would not be awesome to have you here._ +- [Ayush Dhiman](contributions/ayushdhiman-py.txt) ## Submitting a pull request