From 54953bfc453a6bbe780f3ab14fd6aaee2b16c994 Mon Sep 17 00:00:00 2001
From: Sammy Hori <git@sammyhori.com>
Date: Tue, 3 Dec 2024 23:19:11 +0000
Subject: [PATCH] Add warning for people editing the README.md file

This may hopefully reduce the number of people who incorrectly edit the README file in a PR before realising they should edit the data.json instead.

The messages are commented out so won't appear on the README.md when rendered.
---
 .github/README-template.j2 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.github/README-template.j2 b/.github/README-template.j2
index 67942e23..eecc4f05 100644
--- a/.github/README-template.j2
+++ b/.github/README-template.j2
@@ -1,3 +1,8 @@
+<!-- DO NOT EDIT THIS FILE (README.md) -->
+<!-- ALL ENTRIES SHOULD BE IN TO THE data.json -->
+<!-- SEE THE CONTRIBUTING GUIDE (CONTRIBUTING.md) FOR MORE GUIDANCE -->
+<!-- YOU MAY IGNORE THIS MESSAGE IF YOU ARE EDITING THE TEMPLATE -->
+
 # Awesome First PR Opportunities [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
 
 Inspired by [First Timers Only](https://kentcdodds.com/blog/first-timers-only) blog post.