Skip to content

Commit 36c4ca9

Browse files
seanmarciaseanmarcia
committed
More clean up.
1 parent f4831d5 commit 36c4ca9

5 files changed

Lines changed: 13 additions & 17 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**The repository has**:
44

5-
- [ ] At least three issues with the `good first issue`, or other labels specified in `firstissue.json` (see `labels` and the end).
5+
- [ ] At least three issues with the `good first issue`, or other labels specified in `happycommits.json` (see `labels` and the end).
66
- Link:
77
- [ ] At least 10 contributors.
88
- [ ] At least 1000 stars.

‎.github/workflows/deploy.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ jobs:
6363
run: npm run build
6464
env:
6565
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
66-
- name: Update firstissue.json
66+
- name: Update happycommits.json
6767
uses: stefanzweifel/git-auto-commit-action@v4
6868
with:
69-
commit_message: update firstissue.json [skip actions]
69+
commit_message: update happycommits.json [skip actions]
7070
branch: json-updates
71-
file_pattern: 'firstissue.json'
71+
file_pattern: 'happycommits.json'
7272
skip_checkout: true
7373
push_options: '--force'
7474
- name: Static HTML export with Next.js

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You're welcome to add a new project in First Issue, just follow these steps:
1010

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

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

1515
- It has at least 10 contributors.
1616

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

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

23-
- Add your repository's path (in the format `owner/name` and lexicographic order) to [firstissue.json](firstissue.json).
23+
- Add your repository's path (in the format `owner/name` and lexicographic order) to [happycommits.json](happycommits.json).
2424

2525
- 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.
2626

2727
## How does it work?
2828

29-
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.
29+
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.
3030

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

3333

3434
## How to setup the project locally
3535
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.
36-
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.
36+
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.
3737
1. Start the development server and open the app in your browser.
3838

3939
```bash

‎pages/_document.tsx‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,14 @@ export default function Document() {
77
<Head>
88
<meta
99
name="description"
10-
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!"
10+
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!"
1111
/>
1212

1313
<meta property="og:url" content="https://happycommits.dev" />
1414
<meta property="og:type" content="website" />
1515
<meta
1616
property="og:title"
17-
content="First Issue | Issues for your next open-source contribution."
18-
/>
19-
<meta
20-
property="og:description"
21-
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!"
17+
content="Happy Commits | Make your next open-source contribution matter."
2218
/>
2319
<meta property="og:image" content="https://happycommits.dev/meta.png" />
2420

@@ -27,11 +23,11 @@ export default function Document() {
2723
<meta property="twitter:url" content="https://happycommits.dev" />
2824
<meta
2925
name="twitter:title"
30-
content="First Issue | Issues for your next open-source contribution."
26+
content="Happy Commits | Make your next open-source contribution matter."
3127
/>
3228
<meta
3329
name="twitter:description"
34-
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!"
30+
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!"
3531
/>
3632
<meta name="twitter:image" content="https://happycommits.dev/meta.png" />
3733

‎pages/index.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export default function Home() {
99
return (
1010
<>
1111
<Head>
12-
<title>First Issue | Issues for your next open-source contribution</title>
12+
<title>Happy Commits | Make your next open-source contribution matter.</title>
1313
</Head>
1414
<RepositoryList repositories={repositories} />
1515
</>

0 commit comments

Comments
 (0)