Contributing

Basics of Contributing

• Use descriptive commit messages
• Run tests with npm test before submitting a PR / pushing
  • Resolve issues if tests surface them

How You Can Contribute

There are a few things we'll always want to improve in Good First Issue... and are great ways to contribute!

Adding New Projects

See Adding New Projects in the README.md if you would like to add a new project.

Solidifying the Module

Good First Issue can be used as a module! Its original purpose was to be used as a CLI, but it can also be used as a module to surface good first issues for a specific project. If you'd like to help out with solidifying the interface and ensuring that it's a good experience for end-users to consume, we'd love your help.

Enhancing Tests

We use Jest for tests, and Standard for linting. If you would like to help Good First Issue by enhancing our test suite or improving linting, we more than welcome your contributions.

Improving Documentation

We keep our documentation in README.md. If there's anything in there that doesn't currently reflect the state of the module or CLI, or anything that's unclear, improvements are always welcome.