Skip to content

Commit

Permalink
More clean up.
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmarcia committed Sep 16, 2023
1 parent f4831d5 commit 36c4ca9
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**The repository has**:

- [ ] At least three issues with the `good first issue`, or other labels specified in `firstissue.json` (see `labels` and the end).
- [ ] At least three issues with the `good first issue`, or other labels specified in `happycommits.json` (see `labels` and the end).
- Link:
- [ ] At least 10 contributors.
- [ ] At least 1000 stars.
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ jobs:
run: npm run build
env:
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
- name: Update firstissue.json
- name: Update happycommits.json
uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: update firstissue.json [skip actions]
commit_message: update happycommits.json [skip actions]
branch: json-updates
file_pattern: 'firstissue.json'
file_pattern: 'happycommits.json'
skip_checkout: true
push_options: '--force'
- name: Static HTML export with Next.js
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You're welcome to add a new project in First Issue, just follow these steps:

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

- It has at least three issues with the `good first issue` label or other labels defined in `firstissue.json` (see `labels` and the end).
- It has at least three issues with the `good first issue` label or other labels defined in `happycommits.json` (see `labels` and the end).

- It has at least 10 contributors.

Expand All @@ -20,20 +20,20 @@ You're welcome to add a new project in First Issue, just follow these steps:

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

- Add your repository's path (in the format `owner/name` and lexicographic order) to [firstissue.json](firstissue.json).
- Add your repository's path (in the format `owner/name` and lexicographic order) to [happycommits.json](happycommits.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.

## How does it work?

First Issue is a static website that uses Next.js, React and Typescript. The data shown on the website is loaded from the [generated.json](generated.json) file, which is generated by [generate.ts](generate.ts) by querying the GitHub API to fetch issues from the repositories listed in [firstissue.json](firstissue.json). The labels defined in [firstissue.json](firstissue.json) are used to filter issues for the repositories.
First Issue is a static website that uses Next.js, React and Typescript. The data shown on the website is loaded from the [generated.json](generated.json) file, which is generated by [generate.ts](generate.ts) by querying the GitHub API to fetch issues from the repositories listed in [happycommits.json](happycommits.json). The labels defined in [happycommits.json](happycommits.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:


## How to setup the project locally
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.
1. You can use the included [generated.json](generated.json) as dummy data or you can run `npm run prebuild` to fetch the latest data from GitHub yourself: for this, you will need to set the `GH_PERSONAL_ACCESS_TOKEN` environment variable to a valid GitHub Personal Access Token (PAT). Notice: repositories not matching the criteria listed above (see rules in [generated.json](generated.json)) are automatically removed from [firstissue.json](firstissue.json) when the [generated.json](generated.json) script runs.
1. You can use the included [generated.json](generated.json) as dummy data or you can run `npm run prebuild` to fetch the latest data from GitHub yourself: for this, you will need to set the `GH_PERSONAL_ACCESS_TOKEN` environment variable to a valid GitHub Personal Access Token (PAT). Notice: repositories not matching the criteria listed above (see rules in [generated.json](generated.json)) are automatically removed from [happycommits.json](happycommits.json) when the [generated.json](generated.json) script runs.
1. Start the development server and open the app in your browser.

```bash
Expand Down
12 changes: 4 additions & 8 deletions pages/_document.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,14 @@ export default function Document() {
<Head>
<meta
name="description"
content="Making your next open-source contribution doesn't have to be hard. First Issue is a curated list of accessible issues from popular open-source projects to get you started easily on your next contribution. Start today!"
content="Making your next open-source contribution make the world better. Happy Commits is a curated list of accessible issues from open-source projects helping our communities. Start today!"
/>

<meta property="og:url" content="https://happycommits.dev" />
<meta property="og:type" content="website" />
<meta
property="og:title"
content="First Issue | Issues for your next open-source contribution."
/>
<meta
property="og:description"
content="Making your next open-source contribution doesn't have to be hard. First Issue is a curated list of accessible issues from popular open-source projects to get you started easily on your next contribution. Start today!"
content="Happy Commits | Make your next open-source contribution matter."
/>
<meta property="og:image" content="https://happycommits.dev/meta.png" />

Expand All @@ -27,11 +23,11 @@ export default function Document() {
<meta property="twitter:url" content="https://happycommits.dev" />
<meta
name="twitter:title"
content="First Issue | Issues for your next open-source contribution."
content="Happy Commits | Make your next open-source contribution matter."
/>
<meta
name="twitter:description"
content="Making your next open-source contribution doesn't have to be hard. First Issue is a curated list of accessible issues from popular open-source projects to get you started easily on your next contribution. Start today!"
content="Making your next open-source contribution make the world better. Happy Commits is a curated list of accessible issues from open-source projects helping our communities. Start today!"
/>
<meta name="twitter:image" content="https://happycommits.dev/meta.png" />

Expand Down
2 changes: 1 addition & 1 deletion pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default function Home() {
return (
<>
<Head>
<title>First Issue | Issues for your next open-source contribution</title>
<title>Happy Commits | Make your next open-source contribution matter.</title>
</Head>
<RepositoryList repositories={repositories} />
</>
Expand Down

0 comments on commit 36c4ca9

Please sign in to comment.