Skip to content
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.

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

chore: improve formatting of .env.example for better readability #897

Merged
merged 9 commits into from
Dec 14, 2024

Conversation

guzus
Copy link
Contributor

@guzus guzus commented Dec 7, 2024

Relates to:

Risks

Low, because no code has changed

Background

What does this PR do?

  • Ensured consistent spacing and alignment across the file for readability.
  • This update enhances maintainability and makes it easier for contributors to understand and update the file.

No functional changes were made; this commit is purely for structural and visual clarity.

What kind of change is this?

Improvements

Why are we doing this? Any context or related work?

Standardizing formatting aligns with best practices for .env files, ensuring clarity and readability.

Documentation changes needed?

My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

Detailed testing steps

None, automated tests are fine.

Discord username

uncanny_guzus

- Organized the `.env.example` file into clearly defined sections with headers.
- Added comments to describe each configuration variable and its purpose.
- Ensured consistent spacing and alignment across the file for readability.
- Grouped related settings, such as API keys, model configurations, and platform-specific settings, under appropriate headers.
- This update enhances maintainability and makes it easier for contributors to understand and update the file.

No functional changes were made; this commit is purely for structural and visual clarity.
Copy link
Collaborator

@monilpat monilpat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on formatting this much needed - please make sure no comments are lost.

.env.example Show resolved Hide resolved
.env.example Show resolved Hide resolved
@guzus
Copy link
Contributor Author

guzus commented Dec 8, 2024

Thank you for the review @monilpat ! I’ve resolved the issue. Could you please take a look when you get a chance?

@guzus guzus requested a review from monilpat December 8, 2024 06:11
.env.example Show resolved Hide resolved
@guzus
Copy link
Contributor Author

guzus commented Dec 10, 2024

@monilpat I have intentionally minimized the changes in this Pull Request to reduce confusion for contributors, given the rapid pace of updates in the repository. The changes primarily focus on formatting and improving readability without altering the existing structure or comments. Thank you!

@guzus guzus requested a review from monilpat December 10, 2024 16:40
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

weird github still showing the comments and options removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

@monilpat
Copy link
Collaborator

Looks like there are merge conflicts :)

@guzus
Copy link
Contributor Author

guzus commented Dec 11, 2024

yeah, this repository is really growing fast... @monilpat can you pls check again?

@lalalune lalalune changed the base branch from main to develop December 14, 2024 22:38
@lalalune lalalune merged commit 6425845 into elizaOS:develop Dec 14, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants