Skip to content

docs: clarify contribution starting point - #4218

Closed
taigrr wants to merge 1 commit into
mainfrom
cd/readme-contributing-start
Closed

docs: clarify contribution starting point#4218
taigrr wants to merge 1 commit into
mainfrom
cd/readme-contributing-start

Conversation

@taigrr

@taigrr taigrr commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • add a conventional Contributing section to the README with direct links for policies, content examples, and local development docs
  • fix team helper fallbacks now that data/team_members.csv no longer exists, and avoid generating links to missing author pages
  • clean up stale legacy author/self links so the site link checker passes

Fixes #3821

Testing

  • bun run test
  • bun run lint
  • git diff --check
  • bun run clean && bun run build >/tmp/18f-build.log && bun x check-html-links _site --ignore-link-pattern '**/TODO/'\n- GitHub Actions: build, Check all links, validate html, Run linter, CodeQL, Hound all passing

@taigrr
taigrr requested a review from a team as a code owner July 4, 2026 10:07
Comment thread lib/team.js
return `${person.first_name} ${person.last_name}`

}
return `${person.first_name} ${person.last_name}`;

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'template literal syntax' is only available in ES6 (use 'esversion: 6').

Comment thread lib/team.js
return maybePerson
}
const findPerson = (id) => ({
id,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'object short notation' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

Comment thread lib/team.js
}
return maybePerson
}
const findPerson = (id) => ({

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

Comment thread lib/team.js
const { parse } = require('csv-parse/sync'); /* eslint-disable-line import/no-unresolved */
const titleizeSlug = (id) => id
.split('-')
.map((part) => part.charAt(0).toUpperCase() + part.slice(1))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').

Comment thread lib/team.js
@@ -1,30 +1,23 @@
const fs = require('fs');
const { parse } = require('csv-parse/sync'); /* eslint-disable-line import/no-unresolved */
const titleizeSlug = (id) => id

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

@taigrr
taigrr force-pushed the cd/readme-contributing-start branch from 65fb77f to 9730a65 Compare July 4, 2026 10:12
module.exports = async (slug) => {
const name = fullName(findPerson(slug))
return `<a href="/author/${slug.toLowerCase()}/" itemprop="name">${name}</a>`
return `<span itemprop="name">${name}</span>`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'template literal syntax' is only available in ES6 (use 'esversion: 6').
Missing semicolon.
Unrecoverable syntax error. (71% scanned).

module.exports = async (slug) => {
const name = fullName(findPerson(slug))
return `<a href="/author/${slug.toLowerCase()}/" itemprop="name">${name}</a>`
return `<span itemprop="name">${name}</span>`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'template literal syntax' is only available in ES6 (use 'esversion: 6').
Missing semicolon.
Unrecoverable syntax error. (71% scanned).

describe('teamLink filter', () => {
it('returns the team member name without linking to missing author pages', async () => {
expect(await teamLink('melody')).to.equal('<span itemprop="name">Melody</span>')
})

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing semicolon.
Unrecoverable syntax error. (83% scanned).


describe('teamLink filter', () => {
it('returns the team member name without linking to missing author pages', async () => {
expect(await teamLink('melody')).to.equal('<span itemprop="name">Melody</span>')

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
Expected ')' and instead saw 'teamLink'.
Expected ')' to match '{' from line 8 and instead saw '('.
Expected an assignment or function call and instead saw an expression.
Expected an identifier and instead saw ')'.
Expected an operator and instead saw '.'.
Missing semicolon.

const teamLink = require('../../../config/filters/teamLink')

describe('teamLink filter', () => {
it('returns the team member name without linking to missing author pages', async () => {

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Expected '(' and instead saw '{'.


const teamLink = require('../../../config/filters/teamLink')

describe('teamLink filter', () => {

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').


const { expect } = chai

const teamLink = require('../../../config/filters/teamLink')

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).
Missing semicolon.

@@ -0,0 +1,11 @@
const chai = require('chai')

const { expect } = chai

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).
'destructuring binding' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).
Missing semicolon.

@@ -0,0 +1,11 @@
const chai = require('chai')

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).
Missing semicolon.

@taigrr
taigrr force-pushed the cd/readme-contributing-start branch from 9730a65 to ca0af95 Compare July 4, 2026 10:24
@taigrr taigrr closed this Jul 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing instructions for adding a post

2 participants