Skip to content

Commit eb833c9

Browse files
Added contributing and security policies (#142)
1 parent 49e5999 commit eb833c9

File tree

4 files changed

+140
-6
lines changed

4 files changed

+140
-6
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 graham@alt-three.com. 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: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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/), enforced by [StyleCI](https://styleci.io/).
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.
31+
* We also have [StyleCI](https://styleci.io/) setup to automatically fix any code style issues.

.github/SECURITY.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# SECURITY POLICY
2+
3+
## Supported Versions
4+
5+
After each new major (minor) release, the previous release will be supported
6+
for no less than 12 (6) months, unless explictly otherwise. This may mean that
7+
there 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 one the security contacts. All security vulnerabilities will be
13+
promptly addressed. Please do not disclose security-related issues publicly
14+
until a fix has been announced.
15+
16+
### Security Contacts
17+
18+
* Graham Campbell (graham@alt-three.com)
19+
* Julien Didier (genzo.wm@gmail.com)
20+
* Grégoire Pineau (lyrixx@lyrixx.info)
21+
* Alexandre Salomé (alexandre.salome@gmail.com)

composer.json

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,20 @@
44
"license": "MIT",
55
"authors": [
66
{
7-
"name": "Alexandre Salomé",
8-
"email": "alexandre.salome@gmail.com",
9-
"homepage": "http://alexandre-salome.fr"
7+
"name": "Graham Campbell",
8+
"email": "graham@alt-three.com"
9+
},
10+
{
11+
"name": "Julien Didier",
12+
"email": "genzo.wm@gmail.com"
1013
},
1114
{
12-
"name": "Julien DIDIER",
13-
"email": "genzo.wm@gmail.com",
14-
"homepage": "http://www.jdidier.net"
15+
"name": "Grégoire Pineau",
16+
"email": "lyrixx@lyrixx.info"
17+
},
18+
{
19+
"name": "Alexandre Salomé",
20+
"email": "alexandre.salome@gmail.com"
1521
}
1622
],
1723
"homepage": "http://gitonomy.com",

0 commit comments

Comments
 (0)