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

Jump to bottom

Readme templates to help guide the documentation process #24

Open

joshuapease opened this issue May 28, 2024 · 0 comments

Contributor

joshuapease commented May 28, 2024 •

edited

Loading

It would be awesome to have a starter project Readme that outlines best practices for documenting a project:

Local, Staging, Production URLs
First time setup
Getting DB dumps
Running tests
Skeleton for documenting custom modules
Deploy process
etc

Implementation

Remove the existing README.md (which documents how to contribute to the starter).
Rename a README.sample.md to README.md
Use composer-scripts/post-create-project.php to do replacements on text (ddev URL, etc)

The text was updated successfully, but these errors were encountered:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment