Skip to content

Commit

Permalink
Merge pull request #2 from ruchit288/main
Browse files Browse the repository at this point in the history
Add contributing and changelog file and update readme file.
  • Loading branch information
ruchit288 authored Sep 29, 2023
2 parents 8ce4003 + efcdc89 commit 21c9774
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 9 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@


All notable changes to `php-db-auditor` will be documented in this file.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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**!
13 changes: 4 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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**
Expand Down

0 comments on commit 21c9774

Please sign in to comment.