Skip to content

Commit 75974be

Browse files
authored
Merge pull request #1 from ProgMiner/readme
Added some community stuff
2 parents 1bb1be2 + e978563 commit 75974be

File tree

4 files changed

+100
-21
lines changed

4 files changed

+100
-21
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
Contributions are **welcome** and will be fully **credited**.
4+
5+
We accept contributions via Pull Requests on [Github](https://github.com/ProgMiner/php-datagen).
6+
7+
8+
## Pull Requests
9+
10+
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
11+
12+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
13+
14+
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
15+
16+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
17+
18+
- **Create feature branches** - Don't ask us to pull from your master branch.
19+
20+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
21+
22+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
23+
24+
25+
**Happy coding**!

LICENSE

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

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2018 Eridan Domoratskiy <eridan200@mail.ru>
4+
5+
> Permission is hereby granted, free of charge, to any person obtaining a copy
6+
> of this software and associated documentation files (the "Software"), to deal
7+
> in the Software without restriction, including without limitation the rights
8+
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
> copies of the Software, and to permit persons to whom the Software is
10+
> furnished to do so, subject to the following conditions:
11+
>
12+
> The above copyright notice and this permission notice shall be included in
13+
> all copies or substantial portions of the Software.
14+
>
15+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
> THE SOFTWARE.

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# php-datagen
2+
3+
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE.md)
5+
[![Build Status][ico-travis]][link-travis]
6+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ec9d15a8f86f4390b410ef46399f4608)](https://www.codacy.com/app/ProgMiner/php-datagen?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=ProgMiner/php-datagen&amp;utm_campaign=Badge_Grade)
7+
[![Maintainability](https://api.codeclimate.com/v1/badges/a53d266e0050a850e749/maintainability)](https://codeclimate.com/github/ProgMiner/php-datagen/maintainability)
8+
[![Total Downloads][ico-downloads]][link-downloads]
9+
10+
PHP-DataGen is a code generation tool with a built-in parser of own Kotlin-like properties description language to create classes with strongly typed properties.
11+
12+
The base description of the language is in [schema.md](schema.md).
13+
14+
## Install
15+
16+
Via Composer
17+
18+
``` bash
19+
$ composer require progminer/php-datagen
20+
```
21+
22+
## Usage
23+
24+
You can use it from your PHP code or using the CLI.
25+
26+
// TODO
27+
28+
## Contributing
29+
30+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
31+
32+
## Security
33+
34+
If you discover any security related issues, please email eridan200@mail.ru instead of using the issue tracker.
35+
36+
## Credits
37+
38+
- [Eridan Domoratskiy][link-author]
39+
- [All Contributors][link-contributors]
40+
41+
## License
42+
43+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
44+
45+
[ico-version]: https://img.shields.io/packagist/v/progminer/php-datagen.svg?style=flat-square
46+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
47+
[ico-travis]: https://img.shields.io/travis/ProgMiner/php-datagen/master.svg?style=flat-square
48+
[ico-downloads]: https://img.shields.io/packagist/dt/progminer/php-datagen.svg?style=flat-square
49+
50+
[link-packagist]: https://packagist.org/packages/progminer/php-datagen
51+
[link-travis]: https://travis-ci.org/ProgMiner/php-datagen
52+
[link-downloads]: https://packagist.org/packages/progminer/php-datagen
53+
[link-author]: https://github.com/ProgMiner
54+
[link-contributors]: ../../contributors

0 commit comments

Comments
 (0)