https://github.com/arindam200/goodfirstissue

https://github.com/arindam200/goodfirstissue

Last synced: about 13 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/arindam200/goodfirstissue
• Owner: Arindam200
• Created: 2024-05-07T05:33:13.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-07T05:33:19.000Z (6 months ago)
• Last Synced: 2024-09-14T13:09:05.429Z (about 2 months ago)
• Language: JavaScript
• Size: 1000 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @arindam1729/goodfirstissue

This is a simple npm package that fetches open, public issues labeled as "good first issue" from GitHub. It's a great tool for beginners looking for their first contributions or for anyone looking to contribute to open source projects.

## Installation

```bash

npm install @arindam1729/goodfirstissue

```

## Usage

```javascript

const getIssues = require('@arindam1729/goodfirstissue');

// Fetch 10 issues from any language

getIssues().then(issues => console.log(issues));

// Fetch 5 JavaScript issues

getIssues('JavaScript', 5).then(issues => console.log(issues));

```

## API

### getIssues(language, numIssues)

Fetches open, public issues from GitHub.

#### Parameters

- `language` (string, optional): The programming language of the issues. If not provided, issues from any language will be fetched.

- `numIssues` (number, optional): The number of issues to fetch. Default is 10.

#### Returns

A Promise that resolves to an array of issue objects.

## Error Handling

If there's a problem with the fetch operation, the error message will be logged to the console.

## License

MIT