Skip to content

Commit

Permalink
Add a new section to the main README for "Notes for Developers"
Browse files Browse the repository at this point in the history
This commit adds a new section to the README for the documentation
of any non-standard behaviours or other documentation that will help
developers coming to a project understand any idiosyncracies of the project.
  • Loading branch information
jkeasley committed May 10, 2024
1 parent 6e35e8a commit c867ecb
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TODO: Remove the above sections from the README

TODO: Replace the `[Your Project Name]` heading above with the name of your project.

Production:
Production:
Staging:

TODO: Add the production & staging URLs to the above.
Expand Down Expand Up @@ -79,3 +79,7 @@ Use [Whippet](https://github.com/dxw/whippet) to manage plugins or external them
See the [theme README](wp-content/themes/theme/README.md) for more on how to develop the theme.
TODO: Remove the `README.md` from `wp-content/themes/theme`, and rename `README.example.md` to `README.md`, updating it as needed.
## Notes for Developers
TODO: Document any custom or non-standard behaviour that may confuse developers new to the project, e.g. default wordpress or plugin behaviour that is being overridden.

0 comments on commit c867ecb

Please sign in to comment.