|
1 | | -# AutoGitIgnore |
2 | | -A post-update-cmd script to automatically add Composer managed packages to .gitignore. |
| 1 | +# Auto Git Ignore by Novusvetus |
| 2 | +A post-update-cmd script to automatically add Composer managed packages to .gitignore |
| 3 | + |
| 4 | +## Installation |
| 5 | +### Add the following to your composer.json |
| 6 | +```json |
| 7 | +"scripts": { |
| 8 | + "post-update-cmd": "Novusvetus\\AutoGitIgnore\\GitIgnoreBuilder::Go" |
| 9 | +} |
| 10 | +``` |
| 11 | +### Add it to your project with: |
| 12 | +```shell |
| 13 | +composer require novusvetus/autogitignore |
| 14 | +``` |
| 15 | + |
| 16 | +### Exclude only dev packages |
| 17 | +Add to the following to your composer.json |
| 18 | +```json |
| 19 | +"extra": { |
| 20 | + "autogitignore": "devOnly" |
| 21 | +} |
| 22 | +``` |
| 23 | + |
| 24 | +## License |
| 25 | +3-clause BSD license |
| 26 | +See [License](LICENSE) |
| 27 | + |
| 28 | +## Bugtracker |
| 29 | +Bugs are tracked in the issues section of this repository on GitHub. |
| 30 | +Please read over existing issues before submitting an issue to ensure yours is unique. |
| 31 | + |
| 32 | +[Create a new issue](../../issues/new) |
| 33 | + - Describe the steps to reproduce your issue. |
| 34 | + - Describe the expected and the actual outcome. |
| 35 | + - Describe your environment as detailed as possible. |
| 36 | + |
| 37 | +## Development and contribution |
| 38 | +Feature requests can also be made by [creating a new issue](../../issues/new). |
| 39 | +If you would like to make contributions to this module, feel free to [create a fork](../../fork) and submit a pull request. |
| 40 | + |
| 41 | +## Versioning |
| 42 | +This project follows [Semantic Versioning](http://semver.org) paradigm. That is: |
| 43 | + |
| 44 | +> Given a version number MAJOR.MINOR.PATCH, increment the: |
| 45 | +> 1. MAJOR version when you make incompatible API changes, |
| 46 | +> 2. MINOR version when you add functionality in a backwards-compatible manner, and |
| 47 | +> 3. PATCH version when you make backwards-compatible bug fixes. |
| 48 | +> Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format. |
| 49 | +
|
| 50 | +## Thanks to |
| 51 | +[mickaelperrin / Mickaël PERRIN](https://github.com/mickaelperrin) |
0 commit comments