Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

This pull request addresses issue #14(https://github.com/clubgamma/Good_First_Issue_Web_App/issues/14) by updating the readme with relevant information. #29

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

This pull request addresses issue #14(https://github.com/clubgamma/Good_First_Issue_Web_App/issues/14) by updating the readme with relevant information. #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9769df9
updated README.md
Nov 14, 2023
b461f29
updated README.md
Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 27 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<p align="center">
Expand All @@ -23,26 +24,42 @@ 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._
- [Ayush Dhiman](contributions/ayushdhiman-py.txt)

## 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** |
| --- |--- |
Expand Down