Currently, contributors do not have a reference for required environment variables, which can lead to setup confusion or misconfigurations.
To streamline the development process, we should add an env_sample file that outlines the necessary environment variables without sensitive data. Create an env_sample file in the root of the project
Include placeholders for all required environment variables.
Add documentation in the file explaining what each variable does and any necessary values or formats.
Ensure sensitive data is not included—use placeholders (e.g., YOUR_API_KEY_HERE).
Update the README.md with a section on how to use the env_sample file.
Additional context
Benefits:
Improves onboarding for new contributors.
Prevents setup issues related to missing or incorrect environment variables.
rupesh-dev30
commented
1 month ago
Currently, contributors do not have a reference for required environment variables, which can lead to setup confusion or misconfigurations. To streamline the development process, we should add an env_sample file that outlines the necessary environment variables without sensitive data. Create an env_sample file in the root of the project Include placeholders for all required environment variables. Add documentation in the file explaining what each variable does and any necessary values or formats. Ensure sensitive data is not included—use placeholders (e.g., YOUR_API_KEY_HERE). Update the README.md with a section on how to use the env_sample file.
Additional context Benefits: Improves onboarding for new contributors. Prevents setup issues related to missing or incorrect environment variables.