From 00d1aea7bed1526ed5c19a70a1299649f87155f6 Mon Sep 17 00:00:00 2001 From: Ruchit Patel Date: Fri, 29 Sep 2023 11:40:37 +0530 Subject: [PATCH 1/3] Update readme file. --- README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 66778d0..c9d561b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -## PHP DB Auditor +![Packagist License](https://img.shields.io/packagist/l/vcian/php-db-auditor?style=for-the-badge) +[![Total Downloads](https://img.shields.io/packagist/dt/vcian/php-db-auditor?style=for-the-badge)](https://packagist.org/packages/vcian/php-db-auditor) + + ## Introduction - This package provides to audit process of reviewing and evaluating a mysql database system. @@ -9,14 +12,6 @@ > **Requires [PHP 8.1+](https://php.net/releases/) -You can download this package using git clone - - git clone "repo url" - -After the cloned run the following commands - - cd php-db-auditor - Need to install dependency using [Composer](https://getcomposer.org): > #### **composer install** From 93a384c7798ef3b989787dae6cad040c253a2915 Mon Sep 17 00:00:00 2001 From: Ruchit Patel Date: Fri, 29 Sep 2023 11:41:33 +0530 Subject: [PATCH 2/3] Add contributing file. --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e519fa4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +We accept contributions via Pull Requests on [Github](https://github.com/vcian/laravel-db-auditor). + +Please read and understand the contribution guide before creating an issue or pull request. + +## Protocol + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +## Pull Requests + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option. + +- **Create feature branches** - Don't ask us to pull from your master branch. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **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. + +**Happy coding**! From efcdc89652009c1b1bcd6161d8902f988b203b40 Mon Sep 17 00:00:00 2001 From: Ruchit Patel Date: Fri, 29 Sep 2023 11:42:35 +0530 Subject: [PATCH 3/3] Add changelong file. --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9626128 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ + + +All notable changes to `php-db-auditor` will be documented in this file.