Merge branch 'main' into 5-lighthouse-action

WomenInSoftwareEngineeringJP · Apr 24, 2024 · 136c20f · 136c20f
2 parents a5b340f + b1ab81a
commit 136c20f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 8 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,11 @@
+Resolves #<issue number>
+
+## What changed 🧐
+*Please list the changes that are in this PR*
+
+See [CONTRIBUTING](https://github.com/WomenInSoftwareEngineeringJP/home/blob/main/CONTRIBUTING.md) for guidelines
+
+
+## How did you test it? 🧪
+
+*Please describe new unit tests, E2E tests, or manual testing steps.*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,6 @@
 # ✨ Welcome ✨
 
 
-
-
 ## MVP Phase 🌱 
 
 - We are only accepting changes from core team members at this phase. Thanks for your understanding
@@ -11,20 +9,30 @@
    - Clear communication with our bilingual community (EN/JA)
    - a11y to ensure inclusion
    - leveraging automation to ensure quality and developer experience (e.g. gitHub actions is our friend)
+   - Responsive design
+   - keeping it simple
 
 ## Tech Stack ⭐
 I've set us up with a modern frontend tech stack so that we can practice together. This includes TypeScript, which has a bit of a learning curve. 
 
 ## Best Practices
 - Use Editorconfig to match expected style: https://editorconfig.org/
-- This project is set up with eslint for both style and code checking
+- This project is set up with eslint for both style and code checking 🧹
 
-## PR Requirements ☑️
+## Working on an Issue ☑️
 - Please assign yourself to any ticket you are working on. Please unassign yourself if you aren't able to move it forward. Feel free to ask for help if you get stuck.
-- All GH Actions should pass
 - Branch name should start with the ticket number, e.g. `11-dns-setup`
-- Please write unit tests for new enhancements
+- Please write unit tests for new enhancements 🧪
+
+## PR Guidelines
+- All GH Actions should pass ☑️
 - No force pushing to branches ❌
-- Avoid adding arbitrary whitespace
-- Separate logical changes from style changes
+- Avoid adding arbitrary whitespace ❌
+- Separate logical changes from style changes 🔪
+- Try to keep PRs under 500 lines of code 🤏 
+- Making multiple PRs to solve a single issue is okay! 🙆🏻‍♀️
+
+
+## Merging
+- Merging to main triggers a deploy to production. Please check that the site deploys correctly
 
diff --git a/index.html b/index.html
@@ -5,11 +5,14 @@
     <meta charset="UTF-8" />
     <meta property="og:title" content="Women in Software Engineering JP" />
     <meta property="og:type" content="website" />
+    <meta property="og:description"
+        content="Community dedicated to empowering women in Japan in Software Engineering careers" />
     <meta property="og:url" content="https://womeninsoftware.jp" />
     <meta property="og:image" content="https://womeninsoftware.jp/ogp-image.png" />
     <link rel="icon" type="image/svg+xml" href="/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>WiSE Japan</title>
+    <meta name="description" content="Community dedicated to empowering women in Japan in Software Engineering careers">
 </head>
 
 <body>