Skip to content

Commit 2c62a5a

Browse files
code-distortioncode-distortion
committed
Updated documentation
1 parent 9852eec commit 2c62a5a

File tree

7 files changed

+231
-113
lines changed

7 files changed

+231
-113
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
conduct@code-distortion.net.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md renamed to ‎.github/CONTRIBUTING.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
# Contributing
22

3-
Contributions are **welcome** and will be fully **credited**.
4-
53
Please read and understand the contribution guide before creating an issue or pull request.
64

5+
Contributions will be fully credited.
6+
7+
### Please Note
8+
9+
- One of the maintainers' goals is to keep the project concise, so not all PRs will be accepted.
10+
- Maintainers will need to maintain new code for its lifetime, so discretion is used when considering a PR for acceptance.
11+
- If you're unsure, feel free to drop us a line first.
12+
13+
14+
715
## Etiquette
816

917
This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.
@@ -12,10 +20,14 @@ Please be considerate towards maintainers when raising issues or presenting pull
1220

1321
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
1422

23+
24+
1525
## Viability
1626

1727
When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
1828

29+
30+
1931
## Procedure
2032

2133
Before filing an issue:
@@ -28,23 +40,20 @@ Before filing an issue:
2840
Before submitting a pull request:
2941

3042
- Check the codebase to ensure that your feature doesn't already exist.
43+
- Please raise an issue to discuss the problem first.
3144
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
3245

33-
Please Note:
3446

35-
- One of the maintainers' goals is to keep the project concise, so not all PRs will be accepted.
36-
- Maintainers will need to maintain new code for its lifetime, so discretion is used when considering a PR for acceptance.
37-
- If you're unsure feel free to drop us a line first.
3847

3948
## Requirements
4049

41-
- **[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md)** where possible - falling back to [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) otherwise - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer).
50+
- *[PSR-12 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md)* where possible - falling back to [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) otherwise - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
4251

4352
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
4453

45-
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
54+
- **Document any change in behaviour** - Clearly note any changes, so [Fluent Dotenv's documentation](https://github.com/code-distortion/fluent-dotenv) can be updated.
4655

47-
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
56+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is to be avoided.
4857

4958
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
5059

‎.github/ISSUE_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#### Summary:
2+
3+
<!-- Please provide a quick summary of the issue here -->
4+
5+
6+
7+
#### Detailed Description:
8+
9+
<!-- Please provide a detailed description of the issue here, if needed -->
10+
11+
12+
13+
#### Current Behaviour:
14+
15+
<!-- Please explain the current behaviour here -->
16+
17+
18+
19+
#### Versions:
20+
21+
- Fluent dotenv version:
22+
- PHP version:
23+
- OS + version:
24+
25+
26+
27+
#### How To Reproduce:
28+
29+
<!-- Please list steps to reproduce the issue here if possible -->
30+
<!-- This will greatly help in diagnosing the issue -->
31+
<!-- Include details about any relevant factors -->
32+
33+
34+
35+
#### Expected Behaviour:
36+
37+
<!-- Please explain the behaviour you would expect here -->

‎CHANGELOG.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66

77

88

9-
## [0.1.7] - 2023-12-01
9+
## [0.2.0] - 2023-12-16
1010

1111
### Added
1212
- Added support for PHP 8.3
13+
- Updated GitHub Actions workflow to improve platform coverage
14+
- Warning in the documentation that putenv() (which isn't thread-safe) is used to change the getenv() variables temporarily during the .env loading process, when using symfony/dotenv < 5.1.0
15+
- Added support for symfony/dotenv ^7.0
16+
17+
### Fixed
18+
- Fixed bugs when using symfony/dotenv with old versions of PHP on Windows
19+
20+
### Changed
21+
- Removed usage of putenv() temporarily during the .env loading process from all usage of vlucas/phpdotenv (see just below about the new minimum version requirement)
22+
- Removed usage of putenv() temporarily during the .env loading process from usage of symfony/dotenv 5.1.0+
23+
24+
### Removed
25+
- Removed support for (very old versions of) vlucas/phpdotenv < 1.1 - to ensure putenv() isn't used during the .env loading process
1326

1427

1528

‎CODE_OF_CONDUCT.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

‎LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 Tim Chandler
3+
Copyright (c) 2023 Tim Chandler
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)