search

jhnoor / tarik-autocoder

Tarik is an LLM-based automated developer
MIT License
4 stars 2 forks source link

Create an .env-default file with default values for secrets #16

Closed jhnoor closed 1 year ago

jhnoor commented 1 year ago

The .env file is gitignored, but developers that will be onboarded to this project need to know how to use the scripts/dotnet-user-secrets.sh file, and that requires a .env file. Creating a non-ignored .env-default file with correct values will help users along.

Also create a docs folder with a env.MD file that explains the .env file. Make sure to link to that docs page from the README.md.

tarik-tasktopr commented 1 year ago

Step-by-step discussion

In order to create an .env-default file with default values for secrets and a docs folder with an env.MD file that explains the .env file, we need to perform the following steps:

  1. Create a new .env-default file in the root of the repository with default values for secrets.
  2. Create a new docs folder in the root of the repository.
  3. Create a new env.MD file inside the docs folder that explains the .env file.
  4. Update the README.md file to include a link to the env.MD file in the docs folder.

Plan

  1. Create a new file .env-default | To provide default values for secrets and help new developers understand the required format.
  2. Create a new file /docs/env.MD | To explain the .env file and its usage.

  3. Edit the file /README.md | To add a link to the env.MD file in the docs folder, helping new developers find the documentation easily.

    EDIT: Plan approved! ✅