Skip to content

Commit

Permalink
Adding contribution instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Obuhovich committed Oct 18, 2015
1 parent fae0781 commit ce63080
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 5 deletions.
13 changes: 13 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributor Code of Conduct

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.

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.

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.

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.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

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/)
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing
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:

## Asking Questions
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.

## Submitting an issues
- A reproducible example is required for every bug report, otherwise it will most probably be __closed without warning__.
- If you are going to make a big, substantial change, let's discuss it first.

## Working with Pull Requests
1. Create your feature addition or a bug fix branch based on __`master`__ branch in your repository's fork.
2. Make necessary changes, but __don't mix__ code reformatting with code changes on topic.
3. Check your code using "Coding Standard" (see below).
4. Commit your code.
5. Squash your commits by topic to preserve a clean and readable log.
6. Create Pull Request.

## Checking coding standard violations

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:

```bash
$> phpcs --standard="vendor/aik099/coding-standard/CodingStandard" src
```

or by making your IDE ([instructions for PhpStorm](http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html)) to check them automatically.

## Contributor Code of Conduct

Please note that this project is released with a [Contributor Code of
Conduct](http://contributor-covenant.org/). By participating in this project
you agree to abide by its terms. See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) file.
5 changes: 4 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,8 @@
"psr-4": {
"QATools\\PHPUnitExtension\\": "src/QATools/PHPUnitExtension/"
}
}
},
"require-dev": {
"aik099/coding-standard": "dev-master"
}
}
51 changes: 47 additions & 4 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions src/QATools/PHPUnitExtension/AbstractQAToolsTestCase.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
abstract class AbstractQAToolsTestCase extends BrowserTestCase
{

/**
* Browsers.
*
* @var array
*/
public static $browsers = array(
array(
'alias' => 'default',
Expand Down Expand Up @@ -79,4 +84,5 @@ public function getBrowserAliases()
),
);
}

}

0 comments on commit ce63080

Please sign in to comment.