Repository files navigation

You're welcome to add a new project in For Good First Issue, just follow these steps:

• To maintain the quality of projects in For Good First Issue, please make sure the GitHub repository you want to add meets the following criteria:

  • It is a social impact or civic tech project.

  • Ideally, it tags its issues withhelp wanted orgood first issue.

  • In the repository description it lists the sdg(s) it is working on. Seehere for an example.

  • It contains a README.md with detailed setup instructions for the project, and a CONTRIBUTING.md with guidelines for new contributors.

  • It is actively maintained (last update less than 1 month ago).

• Add your repository's path (in the formatowner/name and lexicographic order) tohappycommits.json.

• Create a new pull-request. Please add the link to the issues page of the repository in the PR description. Once the pull request is merged, the changes will be live on the site.

First Issue is a static website that uses Next.js, React and Typescript. The data shown on the website is loaded from thegenerated.json file, which is generated bygenerate.ts by querying the GitHub API to fetch issues from the repositories listed inhappycommits.json. The labels defined inhappycommits.json are used to filter issues for the repositories.

To contribute new features and changes to the website, you would want to run the app locally. Please follow these steps:

1. Fork the repository, clone it locally, create a new branch to work on a specific feature or bug fix without affecting the main branch of the repository. Make sure you have a recent version of Node.js installed on your computer.
2. You can use the includedgenerated.json as dummy data or you can runnpm run prebuild to fetch the latest data from GitHub yourself: for this, you will need to set theGH_PERSONAL_ACCESS_TOKEN environment variable to a valid GitHub Personal Access Token (PAT). Notice: repositories not matching the criteria listed above (see rules ingenerated.json) are automatically removed fromhappycommits.json when thegenerated.json script runs.
3. Start the development server and open the app in your browser.

# install the dependencies$ npm install# start the development server$ npm run dev

Good to know when you commit: the project contains apre-commit hook that runs linters automatically to ensure code quality!

This project is based ongood-first-issue andfirst-issue.