Documentation update and move the deployment branch to gh-pages as it…

… the standard
github · Nov 15, 2023 · 7addf05 · 7addf05
1 parent 954a69b
commit 7addf05
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 12 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,3 +1,5 @@
+<!-- If adding a project to For Good First Issue please uncomment and include the following: 
+
 #### ℹ️ Repository information
 
 **The repository**:
@@ -10,3 +12,5 @@
 - [ ] The project has a code of conduct file.
 - [ ] The project has a license.
 - [ ] Actively maintained (last updated less than 1 months ago).
+-->
+
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -3,7 +3,7 @@ name: Deploy to forgoodfirstissue.dev
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["deploy"]
+    branches: ["gh-pages"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

diff --git a/README.md b/README.md
@@ -1,20 +1,20 @@
 Welcome! 👋🏼
 
-**Happy Commits** curates social impact and civic tech open source projects that are looking for contributors and lists issues on thost projects that are tagged with Help Wanted or Good First Issue.
+**For Good First Issue** curates social impact and civic tech open source projects that are looking for contributors and lists issues on thost projects that are tagged with Help Wanted or Good First Issue.
 
-Open-source maintainers are always looking to get more people involved, but it can be challenging to become a contributor. Happy Commits lowers the barrier for future contributions to social and civic good projects - and this is why it exists.
+Open-source maintainers are always looking to get more people involved, but it can be challenging to become a contributor. For Good First Issue lowers the barrier for future contributions to social and civic good projects - and this is why it exists.
 
 ## Adding a new project
 
-You're welcome to add a new project in First Issue, just follow these steps:
+You're welcome to add a new project in For Good 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:
+- 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 has at least three issues with the `good first issue` label or other labels defined in `happycommits.json` (see `labels` and the end).
+  - It is a social impact or civic tech project.
 
-  - It has at least 10 contributors.
+  - Ideally, it tags its issues with `help wanted` or `good first issue`.
 
-  - It has at least 1000 stars.
+  - In the repository description it lists the sdg(s) it is working on. See [here](https://github.com/rubyforgood/human-essentials) for an example.
 
   - It contains a README.md with detailed setup instructions for the project, and a CONTRIBUTING.md with guidelines for new contributors.
 

diff --git a/pages/_document.tsx b/pages/_document.tsx
@@ -6,7 +6,7 @@ export default function Document() {
       <Head>
         <meta
           name="description"
-          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!"
+          content="Making your next open-source contribution make the world better. For Good First Issue is a curated list of accessible issues from open-source projects helping our communities. Start today!"
         />
 
         <meta property="og:url" content="https://forgoodfirstissue.dev" />
@@ -22,11 +22,11 @@ export default function Document() {
         <meta property="twitter:url" content="https://forgoodfirstissue.dev" />
         <meta
           name="twitter:title"
-          content="Happy Commits | Make your next open-source contribution matter."
+          content="For Good First Issue | Make your next open-source contribution matter."
         />
         <meta
           name="twitter:description"
-          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!"
+          content="Making your next open-source contribution make the world better. For Good First Issueis a curated list of accessible issues from open-source projects helping our communities. Start today!"
         />
         <meta name="twitter:image" content="https://forgoodfirstissue.dev/" />
 

diff --git a/pages/index.tsx b/pages/index.tsx
@@ -33,7 +33,7 @@ export default function Home() {
   return (
     <>
       <Head>
-        <title>Happy Commits | Make your next open-source contribution matter.</title>
+        <title>For Good First Issue | Make your next open-source contribution matter.</title>
       </Head>
 
       <Header />