Skip to content

Commit 4e897bb

Browse files
committed
Add more pre-commit hooks and clean up
1 parent 5173f0c commit 4e897bb

File tree

2 files changed

+27
-8
lines changed

2 files changed

+27
-8
lines changed

.pre-commit-config.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,29 @@ repos:
2727
rev: v6.0.0
2828
hooks:
2929
- id: trailing-whitespace
30+
args: [--markdown-linebreak-ext=md]
3031
- id: end-of-file-fixer
32+
- id: fix-byte-order-marker
33+
name: run fix-byte-order-marker
34+
description: removes UTF-8 byte order marker
35+
- id: forbid-submodules
36+
name: run forbid-submodules
37+
description: forbids any submodules in the repository
3138
- id: check-yaml
3239
- id: check-added-large-files
3340
- id: check-json
3441
- id: check-merge-conflict
3542
- id: check-case-conflict
43+
- id: check-vcs-permalinks
44+
name: run check-vcs-permalinks
45+
description: ensures that links to vcs websites are permalinks
46+
- id: detect-aws-credentials
47+
name: run detect-aws-credentials
48+
description: checks for the existence of AWS secrets that you have set up with the AWS CLI
49+
args: [--allow-missing-credentials]
50+
- id: detect-private-key
51+
name: run detect-private-key
52+
description: checks for the existence of private keys
3653
- id: mixed-line-ending
3754

3855
- repo: https://github.com/pre-commit/mirrors-prettier

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323

2424
## 🎯 About the Project
2525

26-
NextCommunity is a static site directory built with [Eleventy (11ty)](https://www.11ty.dev/) that celebrates the global developer community. Each developer gets their own profile page showcasing their skills, bio, and social links.
26+
NextCommunity is a static site directory built with [Eleventy (11ty)](https://www.11ty.dev/), styled with
27+
[TailwindCSS](https://tailwindcss.com/) and made interactive with JavaScript. NextCommunity celebrates the global
28+
developer community. Each developer gets their own profile page showcasing their skills, bio, and social links.
2729

2830
### 🛠️ Tech Stack
2931

@@ -153,19 +155,19 @@ git push origin main
153155
| `github` | Your GitHub username (without @) | `jbampton` |
154156
| `country` | Your country | `Australia` |
155157
| `location` | Your city | `Brisbane` |
156-
| `role` | Your professional title | `Frontend Developer` |
157-
| `languages` | Space-separated list of technologies | `JavaScript React Node.js` |
158+
| `role` | Your professional title | `Scrum Master` |
159+
| `languages` | Space-separated list of technologies | `JavaScript, Python, Ruby` |
158160
| `bio` | Multi-line biography | See template above |
159161

160162
### Optional Fields
161163

162164
| Field | Description | Example |
163165
| ----------- | -------------------------- | ---------------------------------- |
164-
| `website` | Your personal website URL | `https://yoursite.com` |
165166
| `email` | Your email address | `you@example.com` |
166167
| `instagram` | Full Instagram profile URL | `https://instagram.com/username` |
167-
| `twitter` | Full Twitter/X profile URL | `https://twitter.com/username` |
168168
| `linkedin` | Full LinkedIn profile URL | `https://linkedin.com/in/username` |
169+
| `twitter` | Full Twitter/X profile URL | `https://twitter.com/username` |
170+
| `website` | Your personal website URL | `https://yoursite.com` |
169171

170172
### Field Guidelines
171173

@@ -227,7 +229,7 @@ Want to contribute to the project code or test your profile locally? Here's how
227229

228230
```bash
229231
# Clone the repository
230-
git clone https://github.com/jbampton/NextCommunity.github.io.git
232+
git clone https://github.com/NextCommunity/NextCommunity.github.io.git
231233
cd NextCommunity.github.io
232234
233235
# Install dependencies
@@ -407,6 +409,6 @@ This project is licensed under the **GNU General Public License v3.0** - see the
407409

408410
## 📞 Contact & Support
409411

410-
- **Report bugs**: [Open an issue](https://github.com/jbampton/NextCommunity.github.io/issues)
411-
- **Ask questions**: [Start a discussion](https://github.com/jbampton/NextCommunity.github.io/discussions)
412+
- **Report bugs**: [Open an issue](https://github.com/NextCommunity/NextCommunity.github.io/issues)
413+
- **Ask questions**: [Start a discussion](https://github.com/NextCommunity/NextCommunity.github.io/discussions)
412414
- **Maintainer**: [@jbampton](https://github.com/jbampton)

0 commit comments

Comments
 (0)