Skip to content

Commit ce63080

Browse files
author
Alexander Obuhovich
committed
Adding contribution instructions
1 parent fae0781 commit ce63080

File tree

5 files changed

+103
-5
lines changed

5 files changed

+103
-5
lines changed

CODE_OF_CONDUCT.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6+
7+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8+
9+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10+
11+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12+
13+
This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
QA-Tools / PHPUnit Extension is an open source, community-driven project. If you'd like to contribute, feel free to do this, but remember to follow these few simple rules:
3+
4+
## Asking Questions
5+
Feel free to ask any questions and share your experiences in the [Chat Room](https://gitter.im/qa-tools/qa-tools) and help to improve the documentation.
6+
7+
## Submitting an issues
8+
- A reproducible example is required for every bug report, otherwise it will most probably be __closed without warning__.
9+
- If you are going to make a big, substantial change, let's discuss it first.
10+
11+
## Working with Pull Requests
12+
1. Create your feature addition or a bug fix branch based on __`master`__ branch in your repository's fork.
13+
2. Make necessary changes, but __don't mix__ code reformatting with code changes on topic.
14+
3. Check your code using "Coding Standard" (see below).
15+
4. Commit your code.
16+
5. Squash your commits by topic to preserve a clean and readable log.
17+
6. Create Pull Request.
18+
19+
## Checking coding standard violations
20+
21+
This library uses [Coding Standard](https://github.com/aik099/CodingStandard) to ensure consistent formatting across the code base. Make sure you haven't introduced any Coding Standard violations by running following command in the root folder of the library:
22+
23+
```bash
24+
$> phpcs --standard="vendor/aik099/coding-standard/CodingStandard" src
25+
```
26+
27+
or by making your IDE ([instructions for PhpStorm](http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html)) to check them automatically.
28+
29+
## Contributor Code of Conduct
30+
31+
Please note that this project is released with a [Contributor Code of
32+
Conduct](http://contributor-covenant.org/). By participating in this project
33+
you agree to abide by its terms. See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.

composer.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,8 @@
1616
"psr-4": {
1717
"QATools\\PHPUnitExtension\\": "src/QATools/PHPUnitExtension/"
1818
}
19-
}
19+
},
20+
"require-dev": {
21+
"aik099/coding-standard": "dev-master"
22+
}
2023
}

composer.lock

+47-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/QATools/PHPUnitExtension/AbstractQAToolsTestCase.php

+6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
abstract class AbstractQAToolsTestCase extends BrowserTestCase
1212
{
1313

14+
/**
15+
* Browsers.
16+
*
17+
* @var array
18+
*/
1419
public static $browsers = array(
1520
array(
1621
'alias' => 'default',
@@ -79,4 +84,5 @@ public function getBrowserAliases()
7984
),
8085
);
8186
}
87+
8288
}

0 commit comments

Comments
 (0)