Skip to content

Commit

Permalink
Rename .env example file and update references.
Browse files Browse the repository at this point in the history
    - Renamed `examples/.env.only-optional.example` to `examples/.env.only_optional_mode.example`.
    - Updated `pyproject.toml` and `README.md` references to the renamed file.
    - Improved phrasing in README for clarity on milestones and contribution steps.
  • Loading branch information
jag-k committed Feb 19, 2025
1 parent ad1ca45 commit cd74a2b
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,13 +237,13 @@ See real-world examples of different output formats:
### Environment Files
- [.env.example](examples/.env.example) - Full example with comments and sections
- [.env.only-optional.example](examples/.env.only-optional.example) - Example with only optional fields
- [.env.only_optional_mode.example](examples/.env.only_optional_mode.example) - Example with only optional fields
### Documentation
- [Configuration.md](examples/Configuration.md) - Full configuration documentation with tables and descriptions
- [SimpleConfiguration.md](examples/SimpleConfiguration.md) - Basic table-only configuration
- [InjectedConfiguration.md](examples/InjectedConfiguration.md) - Configuration injected into existing file
- [InjectedConfiguration.md](examples/InjectedConfiguration.md) - Configuration injected into an existing file
## 📚 Learn More
Expand Down Expand Up @@ -275,8 +275,8 @@ This is a personal pet project maintained in my spare time. The development prio
1. Bug fixes
2. Features from Roadmap:
- Issues with closest milestone.
- General milestone issues.
- Issues with the closest milestone,
- General milestones' issues.
- Issues labeled `bug` or `feature request`.
- Features listed in this README.
3. New feature proposals
Expand All @@ -296,7 +296,7 @@ This project uses modern Python development tools:
We welcome contributions! Before contributing:
1. Create a GitHub Issue first — this is **required**
1. Create a GitHub Issue as the first step — this is **required**
2. Fork the repository
3. Create a branch following our naming convention:
- Format: `<domain>/<issue-number>-<short-description>`.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ paths = [

[[tool.pydantic_settings_export.generators.dotenv]]
paths = [
"examples/.env.only-optional.example",
"examples/.env.only_optional_mode.example",
]
mode = "only-optional"
split_by_group = false
Expand Down

0 comments on commit cd74a2b

Please sign in to comment.