Skip to content

Commit fdc1254

Browse files
Updated contact details and policies
1 parent 2b0567a commit fdc1254

File tree

5 files changed

+139
-18
lines changed

5 files changed

+139
-18
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# CONTRIBUTOR COVENANT CODE OF CONDUCT
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# CONTRIBUTION GUIDELINES
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via pull requests on Github. Please review these guidelines before continuing.
6+
7+
## Guidelines
8+
9+
* Please follow the [PSR-2 Coding Style Guide](https://www.php-fig.org/psr/psr-2/)..
10+
* Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
11+
* Send a coherent commit history, making sure each individual commit in your pull request is meaningful.
12+
* You may need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts.
13+
* If you are changing or adding to the behaviour or public api, you may need to update the docs.
14+
* Please remember that we follow [SemVer](https://semver.org/).
15+
16+
## Running Tests
17+
18+
First, install the dependencies using [Composer](https://getcomposer.org/):
19+
20+
```bash
21+
$ composer install
22+
```
23+
24+
Then run [PHPUnit](https://phpunit.de/):
25+
26+
```bash
27+
$ vendor/bin/phpunit
28+
```
29+
30+
The tests will be automatically run by [Travis CI](https://travis-ci.org/) against pull requests.

.github/SECURITY.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# SECURITY POLICY
2+
3+
## Supported Versions
4+
5+
After each new major release, the previous release will be supported for no
6+
less than 2 years, unless explictly stated otherwise. This may mean that there
7+
are multiple supported versions at any given time.
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability within this package, please send an
12+
email to Graham Campbell at [email protected]. All security vulnerabilities
13+
will be promptly addressed. Please do not disclose security-related issues
14+
publicly until a fix has been announced.

README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@ variables loaded with their values, rather than an array of raw lines from the
2727
environment file ([#306](https://github.com/vlucas/phpdotenv/pull/306)).
2828

2929
For more details, please see the
30-
[release notes](https://github.com/vlucas/phpdotenv/releases/tag/v3.0.0) and the [upgrading guide](UPGRADING.md).
30+
[release notes](https://github.com/vlucas/phpdotenv/releases/tag/v3.0.0) and
31+
the [upgrading guide](UPGRADING.md).
3132

3233

3334
Why .env?
3435
---------
36+
3537
**You should never store sensitive credentials in your code**. Storing
3638
[configuration in the environment](http://www.12factor.net/config) is one of
3739
the tenets of a [twelve-factor app](http://www.12factor.net/). Anything that is
@@ -56,16 +58,10 @@ variables, and you're going to love it!
5658
Installation with Composer
5759
--------------------------
5860

59-
```shell
60-
curl -s http://getcomposer.org/installer | php
61-
php composer.phar require vlucas/phpdotenv
62-
```
63-
64-
Or on Existing projects
65-
6661
```shell
6762
composer require vlucas/phpdotenv
6863
```
64+
6965
Usage
7066
-----
7167
The `.env` file is generally kept out of version control since it can contain
@@ -288,14 +284,14 @@ it into your local shell session:
288284
source .env
289285
```
290286

291-
Contributing
292-
------------
293287

294-
1. Fork it
295-
2. Create your feature branch (`git checkout -b my-new-feature`)
296-
3. Make your changes
297-
4. Run the tests, adding new ones for your own code if necessary (`phpunit`)
298-
5. Commit your changes (`git commit -am 'Added some feature'`)
299-
6. Push to the branch (`git push origin my-new-feature`)
300-
7. Create new Pull Request
288+
Security
289+
--------
290+
291+
If you discover a security vulnerability within this package, please send an email to Graham Campbell at [email protected]. All security vulnerabilities will be promptly addressed. You may view our full security policy [here](https://github.com/vlucas/phpdotenv/security/policy).
292+
293+
294+
License
295+
-------
301296

297+
PHP dotenv is licensed under [The BSD 3-Clause License](LICENSE).

composer.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@
44
"keywords": ["env", "dotenv", "environment"],
55
"license" : "BSD-3-Clause",
66
"authors" : [
7+
{
8+
"name": "Graham Campbell",
9+
"email": "[email protected]",
10+
"homepage": "https://gjcampbell.co.uk/"
11+
},
712
{
813
"name": "Vance Lucas",
914
"email": "[email protected]",
10-
"homepage": "http://www.vancelucas.com"
15+
"homepage": "https://vancelucas.com/"
1116
}
1217
],
1318
"require": {

0 commit comments

Comments
 (0)