Good First Issue
A CLI for finding issues labeled with Good First Issue to help lower the barrier to contributing to open source projects.
Table of Contents
- TODOs: What's coming up next
- Adding New Projects
- Release Process
- Labels and Milestones
To use Good First Issue, you'll need to have a few things installed:
- Node.js 8.0.0 or above
- 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
This module is an interactive CLI. If you're looking for a module to use in an application, check out libgfi.
The suggested usage is via npx:
npx good-first-issue [project] # temporarily install and run the module, optionally passing `project`
Alternatively, you could absolutely install good-first-issue as a global module:
npm i -g good-first-issue # install globallygood-first issue # call the CLI
good-first-issue: open up the interactive project selection tool.
good-first-issue [project]: you can pass in a name from the list of projects which is a curated list of projects that have been verified to have good-first-issues.
good-first-issue [GitHub organization or user]: similar to
[project]but will search any GitHub organization or user that exists for issues labeled with "Good First Issue".
good-first-issue [GitHub organization or user]/[repo]: similar to
[project], but will search a specific repository on GitHub within the organization for issues labeled with "Good First Issue".
-o, --open- open in browser
-f, --first- Return first/top issue
TODOs: What's coming up next
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:
- Interactive selector when
good-first-issueis run without a sub command
- 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
Feeling Luckyto be better about picking a random issue
- Add more tests
If you'd like to help with any of these, feel free to submit a PR or ask how you can help 🤗
The table of projects which are currently supported.
||A community building flexible open source tools for GraphQL.|
|4.||Create React App||
||Set up a modern web app by running one command.|
||The Firefox debugger that works anywhere.|
||Easy to maintain open source documentation websites.|
||It has never been so easy to document your things!|
||EasyGraphQL is a group of open source tools, with the main focus to help developers that use GraphQL or just want to start using it.|
||Open Source, Distributed, RESTful Search Engine|
|10.||Elasticsearch Node.js Client||
||Official Elasticsearch client library for Node.js|
||Fast and low overhead web framework, for Node.js|
|14.||I'm Feeling Lucky (Random Project)||
||Receive a good first issue from any eligible project|
||The missing package manager for macOS|
||A terminal built on web technologies|
||Gatsby is a free and open source framework based on React that helps developers build blazing fast websites and apps.|
||The Block Editor project for WordPress and beyond.|
|19.||Good First Issue||
||CLI for finding good first issues.|
||React components for faster and easier web development. Build your own design system, or start with Material Design|
||Neos is a Content Application Platform with a CMS and an application framework at its core.|
||Netlify builds, deploys and hosts your front-end.|
||A bignum library for PHP|
|28.||Quantum Development Kit||
||Compiler, libraries, editor integration, runtime, samples, and tutorials for the Q# programming language.|
||A frontend Framework for building admin applications running in the browser on top of REST/GraphQL APIs, using ES6, React and Material Design.|
||A framework for building native apps with React.|
||Routing and navigation for your React Native apps.|
||Take your first steps as an open source contributor|
||iOS text view (UIView) that properly displays LaTeX, HTML, Markdown, and YouTube/Vimeo links|
||scikit-learn: machine learning in Python|
||A fast high-level web crawling & scraping framework for Python.|
|37.||Spring Cloud GCP||
||Integration for Google Cloud Platform APIs with Spring|
||Open source Node.js Headless CMS to easily build customisable APIs.|
||Storybook is an open source tool for developing UI components in isolation for React, Vue, and Angular. It makes building stunning UIs organized and efficient.|
||Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress.|
||VS Code is a type of tool that combines the simplicity of a code editor with what developers need for their core edit-build-debug cycle.|
||webpack CLI provides a flexible set of commands for developers to increase speed when setting up a custom webpack project.|
||A lightweight private npm proxy registry|
||Fast, reliable, and secure dependency management.|
|48.||Yarn Version Manager||
||YVM is a version manager for yarn that makes it easy to handle projects with differing yarn versions.|
Adding New Projects
If you'd like to add a new project to
good-first-issue, you're more than welcome to submit a PR! There are a few components you'll need to submit:
- Add your
<project>as a property of
projectsin the correct alphabetical position with an object that includes a
description, and a
q(representing the GitHub search query).
- Add your
npm run markdown
- This will automatically update README.md with the new project's data.
Adding New Projects: More Information
You can pull your queries directly from a standard GitHub search! If you want to build something a bit more complex, you can use the advanced search tool if you want to build more specific custom queries: https://github.com/search/advanced
As a CLI,
good-first-issue uses the Commander.js CLI framework. If you want to better understand how our CLI is built, commander.js is pretty well documented. Also used are Chalk for terminal coloring and boxen to simplify the output container implementation.
Good First Issue follows a relatively strict release process intended to ensure the spice flows.
|Major (x.x.x)||Breaking changes and non-trivial upgrades||Ensuring that end-users can rely on Good First Issue not breaking however they're consuming it|
|Minor (x.x.x)||Project additions, other feature additions||Following the SemVer standard, project additions and feature additions are backwards-compatible enhancements. We generally try to ship one addition per Minor.|
|Patch (x.x.x)||Bug fixes, minor enhancements to metadata and content||Tiny, hardly visible fixes to improve UX/DX or fix the module|
Labels and Milestones
We use both GitHub Labels and Milestones to track releases. Since project additions count as a minor release, we prefer to space those out and ship them individually rather than shipping many at once. This pace may be revised later, but for now, it introduces the need for a release queue and setting things up to be released ahead of them actually being released.
Once a PR is ready to be released, a milestone will be added that correlates to the SemVer version it will be released in. Ideally this will eventually be used for changelog tracking but for now it's just a good way to keep organized. To keep things tidy, once a new version has shipped the milestone will be closed out.
Prior to each release, whoever is releasing should be testing the release locally to ensure that the code is working as expected. This would include either running
npm i -g or
npm link in the PR branch and then testing whatever the PR is adding. Ensuring the experience isn't broken is vital.
It is worth noting that we limit the file we publish to npm with the
files property in
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:
npm i -g # This assumes your current working directory is the module's directorygood-first-issue # run the interactive CLIgood-first-issue react # test the react projectgood-first-issue node # test the Node.js projectgood-first-issue github # test the GitHub organization, `github`good-first-issue github/semantic # test the GitHub repo, `github/semantic`good-first-issue thisisntarealprojectorgithuborg
If you are interested in fixing issues and contributing directly to the code base, please see the document CONTRIBUTING.md