Use this template to document exactly how a new contributor can get your project running.
- Git
- Required runtime(s) and version(s):
<fill in> - Package/build tool(s):
<fill in> - Platform-specific dependencies:
<fill in or remove>
-
Clone the repository:
git clone <repo-url> cd <repo-directory>
-
Install dependencies:
<install-command>
-
Configure local environment:
- Copy environment template(s):
<example: cp .env.example .env> - Set required secrets/variables:
<list keys or link to secure vault instructions>
-
Run checks/tests:
<lint-command> <test-command>
-
Start the application or docs locally:
<run-command>
- Expected success signal(s):
<what should be visible in terminal/browser> - Health endpoint or smoke test command:
<fill in>
-
Common issue:
<issue> -
Fix:
<resolution> -
Common issue:
<issue> -
Fix:
<resolution>