Skip to content

On Updating contribution guidelines #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
john-walter-munene wants to merge 2 commits into
base: main
Choose a base branch
from
Open

On Updating contribution guidelines #40

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e474435
On Updating contribution guidelines
john-walter-munene Dec 5, 2025
d12e288
Update README with correct article slug format
john-walter-munene Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,17 +101,17 @@ Don't worry if you're new to GitHub - here's a simple step-by-step guide:
- Click the pencil icon to edit the file
- Add your article information to the `articles` array at the top (it will appear first on the website)
- Use this format:
\`\`\`json
``` json
{
"slug": "your-article-title",
"title": "Your Article Title Here",
"author": "Your Name",
"date": "2024-01-25",
"image": "/images/your-header-image.jpg",
"excerpt": "A brief description of your article that will appear on the homepage.",
"featured": false
"slug": "your-article-filename", // Must exactly match your markdown filename (without the ".md" extension)
"title": "Your Article Title Here",
"author": "Your Name",
"date": "YYYY-MM-DD", // Example: "2024-01-25"
"image": "/images/your-header-image.jpg",
"excerpt": "A brief description of your article that appears on the homepage.", // Meta description for SEO
"featured": false // Set to true only if the article should be highlighted (ask first)
}
\`\`\`
```
- **Important**: Add a comma after the previous entry and ensure proper JSON formatting
- **Featured articles**: Set `"featured": true` if you want your article highlighted with a star (ask us first)
- Commit the changes with a message like "Add [article title] to index"
Expand Down