Skip to content

[Dotenv] improve documentation for dotenv component #60570

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
Open
wants to merge 2 commits into
base: 7.4
Choose a base branch
from
Open

[Dotenv] improve documentation for dotenv component #60570

wants to merge 2 commits into from

Conversation

crydotsnake
Copy link

@crydotsnake crydotsnake commented May 28, 2025 •
edited by GromNaN
Loading

Q A
Branch? 7.4
Bug fix? no
New feature? no
Deprecations? no
Issues -
License MIT

Improves the documentation for the Symfony dotenv component :)

@carsonbot carsonbot added this to the 7.4 milestone May 28, 2025
@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 7.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@carsonbot

This comment was marked as outdated.

Sign in to view
GromNaN
GromNaN reviewed May 28, 2025
View reviewed changes
Copy link
Member

@GromNaN GromNaN left a comment

Choose a reason for hiding this comment

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

We don't have a specific documentation page for this component, so we can improve the readme here to make it more comprehensible to beginners.

@GromNaN GromNaN added the Dotenv label May 28, 2025
@carsonbot carsonbot changed the title TASK: improve documentation for dotenv symfony component [Dotenv] TASK: improve documentation for dotenv symfony component May 28, 2025
@GromNaN GromNaN changed the title [Dotenv] TASK: improve documentation for dotenv symfony component [Dotenv] improve documentation for dotenv component May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@GromNaN GromNaN GromNaN approved these changes

Assignees
No one assigned
Labels
Dotenv Status: Reviewed
Projects
None yet
Milestone
7.4
Development

Successfully merging this pull request may close these issues.
4 participants
@crydotsnake @carsonbot @nicolas-grekas @GromNaN