Skip to content

Commit e8f1740

Browse files
committed
fix(CONTRIBUTING): improved reading experiences and fixed some typos
1 parent 0605371 commit e8f1740

1 file changed

Lines changed: 4 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ We welcome:
2727
- **Topic summaries** (background, trade-offs, relevant work)
2828
- **Resource lists** (papers, PRs, BIPs, mailing-list threads)
2929
- **Corrections/improvements** (typos, clarifications, structure)
30-
- **New templates** that improve contributor experience
30+
- **New templates** that improve the contributor experience
3131

3232
We avoid:
3333

@@ -38,7 +38,7 @@ We avoid:
3838

3939
## Contribution workflow
4040

41-
1. **Open an Issue** (optional but recommended for bigger changes) and describe what you'fll add or fix.
41+
1. **Open an Issue** (optional but recommended for bigger changes) and describe what you'll add or fix.
4242
2. **Fork** the repo and create a feature branch:
4343

4444
git checkout -b docs/2025-10-seminar-notes
@@ -78,15 +78,6 @@ If you create the branch from the GitHub UI, try to avoid generic names like `pa
7878

7979
## Commit message conventions
8080

81-
We follow a lightweight style similar to what is already used in `saopaulobitdevs.org`, for example:
82-
83-
- `feat: november meetup`
84-
- `feat(header): add X (@saopaulobitdevs) link to navigation`
85-
- `feat(_posts): arkade announcement`
86-
- `fix(_posts): use xcancel. fuck X`
87-
- `fix broken link and remove two topics`
88-
- `2025-09 (#68)`
89-
9081
General rules:
9182

9283
- Write commit messages in **English**.
@@ -110,12 +101,12 @@ Common types:
110101
Examples for this repository:
111102

112103
- `feat(topics): add socratic seminar 040`
113-
- `feat(posts): add november 2025 meetup`
104+
- `feat(posts): add nov 2025 meetup`
114105
- `fix(links): update delvingbitcoin URLs for september`
115106
- `docs: add contribution guidelines`
116107
- `chore(posts): reorder sections by topic`
117108

118-
If you are working on a seminar topic file and that's the only change in the PR, a short and focused subject like below is fine:
109+
If you are working on a seminar topic file and that's the only change in the PR, a short and focused subject like the one below is fine:
119110

120111
- `2025-09: add socratic seminar topics`
121112

0 commit comments

Comments
 (0)