-
Notifications
You must be signed in to change notification settings - Fork 230
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated readme and added contributing document
- Loading branch information
Showing
2 changed files
with
39 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Contributing | ||
|
||
## Bug Reports | ||
When filing a bug report, your issue should contain a title and a clear description of the issue. You should include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix. | ||
|
||
Remember, bug reports are created in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the bug report will automatically see any activity or that others will jump to fix it. Creating a bug report serves to help yourself and others start on the path of fixing the problem. | ||
|
||
## Pull Requests | ||
|
||
### New Features | ||
For new features, please open an issue in the issue tracker to discuss the feature. We'd hate to see you put a lot of effort into something only for it to be rejected for any reason! | ||
|
||
If you propose a new feature or drastic change to any existing functionality, please be willing to implement at least some of the code that would be needed to complete the feature. | ||
|
||
Please open one pull request per feature. If you're wanting to add or do multiple things, send multiple pull requests. | ||
|
||
### Coding Standards | ||
We follow the [PSR-2 coding standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) - don't worry if your code isn't perfect in this regard, we will apply automatic styling when merging. Being as close as possible to the standard helps when we manually review your code. | ||
|
||
### Tests | ||
Please write tests for any new feature you add. Your code won't be accepted otherwise. | ||
|
||
### Documentation and Changes | ||
Please open a pull request within our [documentation](https://github.com/caffeinated/website) for this package with updated information regarding your update. | ||
|
||
Also, please update the [CHANGELOG](CHANGELOG.md) with any changes, removals, or additions your pull request is making under the *Unreleased* section at the top of the file. We follow the [Keep a Changlog](https://keepachangelog.com/en/1.0.0/) conventions. | ||
|
||
### Branches | ||
Please create a feature branch. We will not accept pull requests from your master branch. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,7 +10,7 @@ Extract and modularize your code for maintainability. Essentially creates "mini- | |
This package follows the FIG standards PSR-1, PSR-2, and PSR-4 to ensure a high level of interoperability between shared PHP code. | ||
|
||
## Documentation | ||
You will find user friendly and updated documentation in the wiki here: [Caffeinated Modules Wiki](https://github.com/caffeinated/modules/wiki) | ||
You will find user friendly and updated documentation on the [Caffeinated website](https://caffeinatedpackages.com/guide/packages/modules.html). | ||
|
||
## Installation | ||
Simply install the package through Composer. From here the package will automatically register its service provider. | ||
|
@@ -33,16 +33,19 @@ To publish the config file, run the following: | |
php artisan vendor:publish --provider="Caffeinated\Modules\ModulesServiceProvider" --tag="config" | ||
``` | ||
|
||
## Changelog | ||
You will find a complete changelog history within the [CHANGELOG](CHANGELOG.md) file. | ||
|
||
## Contributing | ||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | ||
|
||
## Testing | ||
Run the tests with: | ||
Run tests with PHPUnit: | ||
|
||
``` bash | ||
```bash | ||
vendor/bin/phpunit | ||
``` | ||
|
||
## Contributing | ||
Please see [CONTRIBUTING](CONTRIBUTING) for details. | ||
|
||
## Security | ||
If you discover any security related issues, please email [email protected] directly instead of using the issue tracker. | ||
|
||
|
@@ -51,4 +54,4 @@ If you discover any security related issues, please email [email protected] | |
- [All Contributors](../../contributors) | ||
|
||
## License | ||
The MIT License (MIT). Please see [License File](LICENSE) for more information. | ||
The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |