Skip to content
Open
Changes from all commits
Commits
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
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Good First Issue

A CLI for finding issues labeled with Good First Issue to help lower the barrier to contributing to open source projects.
A CLI for finding issues labeled with **Good First Issue** to help lower the barrier to contributing to open source projects.

[![Shields.io badge for the latest version of good-first-issue](https://img.shields.io/npm/v/good-first-issue/latest.svg)](https://www.npmjs.com/package/good-first-issue)
![[Greenkeeper badge](https://greenkeeper.io/)](https://badges.greenkeeper.io/cutenode/good-first-issue.svg)
Expand Down Expand Up @@ -30,14 +30,20 @@ A CLI for finding issues labeled with Good First Issue to help lower the barrier

## Prerequisites

To use Good First Issue, you'll need to have a few things installed:
To use **Good First Issue**, you'll need to have a few things installed:

- Node.js 8.0.0 or above:
- If you need to install Node.js, you can download it from the [official downloads page](https://nodejs.org/en/download/).
- If you want to use a dynamic version manager, you can use something like nvm [on macOS, Linux, and WSL](https://gist.github.com/d2s/372b5943bce17b964a79).
- npm 5.0.0 or above:
- If you already have Node.js 8.0.0 or above, you will have npm 5.0.0 or above.
- If you need to update your npm CLI, run `npm i -g npm`.
### Node.js 8.0.0 or above

- [Download from the official site](https://nodejs.org/en/download/)
- Or use a version manager like [nvm](https://gist.github.com/d2s/372b5943bce17b964a79) for macOS, Linux, or WSL

### npm 5.0.0 or above

- Comes with Node.js 8.0.0+
- To update npm, run:
```bash
npm i -g npm
```

## Usage

Expand Down Expand Up @@ -76,7 +82,7 @@ good-first-issue # call the CLI
`good-first-issue` is still in an early state. I wanted to get `good-first-issue node` out the door, but have some other things I'm planning on implementing. Here's a list:

- [x] `good-first-issue node` command
- [x] Interactive selector when `good-first-issue` is run without a sub command
- [x] Interactive selector when `good-first-issue` is run without a subcommand
- [ ] Add additional useful commands
- [ ] Explore adding a secondary selector that shows paginated results from GitHub, allowing the user to select which Good First Issue to pick rather than returning a random one
- [ ] Improve `Feeling Lucky` to be better about picking a random issue
Expand Down Expand Up @@ -188,7 +194,7 @@ Prior to each release, whoever is releasing should be testing the release locall

It is worth noting that we limit the file we publish to npm with the `files` property in [`package.json`](https://github.com/bnb/good-first-issue/blob/master/package.json). This property prevents code that's not explicitly listed from being shipped. We have had a situation where local testing and the published module differed because a PR was merged that added needed code in a directory that wasn't included. So, what works on your machine may not work for the end user.

To test locally, using the modules tests with `npm test` and trying out a few different commands (like the selector, a specific project, a failed project, and so on) is reccomended. For example:
To test locally, using the modules tests with `npm test` and trying out a few different commands (like the selector, a specific project, a failed project, and so on) is recommended. For example:

```text
npm i -g # This assumes your current working directory is the module's directory
Expand Down