Skip to content

Inspired by Good First Issues, this project aims to empower first-time contributors to find repositories and issues to contribute to.

License

Notifications You must be signed in to change notification settings

Honsei901/better-first-issues

 
 

Repository files navigation

Better First Issues

Allows Developers to better look for, and select their first open source contribution. You can also use this tool to just look for random repositories or issues that might fancy you.

Visit the tool here.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

Prerequisites

Requirements for the software and other tools to build, test and push.

  • Node - I use Node v16.6.2 but really anything 12+ should work.

Installing

Clone this repository to your machine and run

npm install

To start up the dev server, run this:

npm run dev

Running the tests

We have no tests :(

Sample Tests

We'd like to add test cases. Check out the issues to learn more.

Style test

Check if the best practices and the right coding style has been used. Run an npm run lint to see if there's any styling errors. Also run npm run lint:fix to fix issues that can be auto-fixed.

Note that the build process will fail if there are lint issues.

Deployment

NextJS works a bit differently to other JS dev-build cycles. To prepare for deployment, run this command:

npm run build

This compiles and bundles the code into the .next folder. After this is done, run this command to start the production server.

npm run start

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the CC0 2.1 Universal Creative Commons License - see the LICENSE file for details

Acknowledgments

  • Daren Sin - Created Good First Issues, the inspriation for this project - darensin01
  • Billie Thompson - Provided README Template - PurpleBooth
  • Tom Boettger - Provided CONTRIBUTING Template - bttger

About

Inspired by Good First Issues, this project aims to empower first-time contributors to find repositories and issues to contribute to.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 91.0%
  • CSS 6.1%
  • JavaScript 1.6%
  • SCSS 1.3%