docs: add explicit PLACEHOLDER and TODO markers in the readme

This will serve as clear indicators:

- Readers will know the content is auto-generated
- Maintainers will know the content needs to be updated
- Maintainers will know where edits are needed
- Linters can find these markers to alert people that work is needed.

CHANGELOG.rst

@@ -5,6 +5,16 @@ Change Log
    This file loosely adheres to the structure of https://keepachangelog.com/,
    but in reStructuredText instead of Markdown.
 
+2020-08-12
+**********
+
+.. I wish we used a tool to manage changelogs so that I didn't have to choose
+    a date when I made a commit, since I don't know what date the change will
+    be merged...
+
+- Added explicit PLACEHOLDER and TODO markers to the README to make clear where
+  edits are needed.
+
 2020-08-08
 **********
 

python-template/{{cookiecutter.placeholder_repo_name}}/README.rst

@@ -3,8 +3,10 @@
 
 .. note::
 
-  This README was auto-generated. Please review its contents and update all
-  relevant sections.
+  This README was auto-generated. Maintainer: please review its contents and
+  update all relevant sections. Instructions to you are marked with
+  "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
+  note when you are done.
 
 |pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
 |license-badge| |status-badge|
@@ -14,7 +16,7 @@ Purpose
 
 {{ cookiecutter.project_short_description}}
 
-The ``README.rst`` file should start with a brief description of the repository and its purpose.
+TODO: The ``README.rst`` file should start with a brief description of the repository and its purpose.
 It should be described in the context of other repositories under the ``openedx``
 organization. It should make clear where this fits in to the overall Open edX
 codebase and should be oriented towards people who are new to the Open edX
@@ -31,7 +33,7 @@ One Time Setup
 .. code-block::
 
   # Clone the repository
-  git clone [email protected]:edx/{{ cookiecutter.repo_name }}.git
+  git clone [email protected]:openedx/{{ cookiecutter.repo_name }}.git
   cd {{ cookiecutter.repo_name }}
 
   # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
@@ -76,9 +78,10 @@ Every time you develop something in this repo
 Deploying
 =========
 
-How can a new user go about deploying this component? Is it just a few commands? Is there a larger how-to that should be linked here?
+TODO: How can a new user go about deploying this component? Is it just a few
+commands? Is there a larger how-to that should be linked here?
 
-For details on how to deploy this component, checkout the `deployment how-to`_
+PLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_
 
 .. _deployment how-to: https://docs.openedx.org/projects/{{ cookiecutter.repo_name }}/how-tos/how-to-deploy-this-component.html
 
@@ -88,14 +91,15 @@ Getting Help
 Documentation
 =============
 
-Start by going through `the documentation`_.  If you need more help see below.
+PLACEHOLDER: Start by going through `the documentation`_.  If you need more help see below.
 
 .. _the documentation: https://docs.openedx.org/projects/{{cookiecutter.repo_name}}
 
 (TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)
 
 More Help
 =========
+
 If you're having trouble, we have discussion forums at
 https://discuss.openedx.org where you can connect with others in the
 community.
@@ -181,7 +185,7 @@ Please do not report security issues in public. Please email [email protected].
     :target: https://github.com/edx/{{ cookiecutter.repo_name }}/blob/main/LICENSE.txt
     :alt: License
 
-.. Choose one of the statuses below and remove the other status-badge lines.
+.. TODO: Choose one of the statuses below and remove the other status-badge lines.
 .. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
 .. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
 .. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange