Skip to content

Commit 32b9add

Browse files
committed
WIP - add testing capabilities
1 parent d11d95c commit 32b9add

10 files changed

+4616
-1
lines changed

.travis.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
language: php
2+
3+
php:
4+
- 7.0
5+
- 7.1
6+
7+
before_script:
8+
- travis_retry composer self-update
9+
- travis_retry composer install --no-interaction --prefer-source --dev
10+
11+
script:
12+
- ./vendor/bin/phpunit --coverage-text --coverage-clover ./build/logs/clover.xml
13+
14+
after_script:
15+
- php vendor/bin/coveralls
16+
- wget https://scrutinizer-ci.com/ocular.phar
17+
- php ocular.phar code-coverage:upload --format=php-clover ./build/logs/clover.xml

CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# How to contribute
2+
We welcome everyone to submit pull requests with:
3+
- fixes for issues
4+
- change suggestions
5+
- updateing of documentation
6+
7+
However, not every pull request will automatically be accepted. I will review each carefully to make sure it is in line with
8+
the direction I want the package to continue in. This might mean that some pull requests are not accepted, or might stay
9+
unmerged until a place for them can be determined.
10+
11+
## Testing
12+
- [ ] After making your changes, make sure the tests still pass.
13+
- [ ] When adding new functionality, also add new tests.
14+
- [ ] Make sure there are no build errors on our CI server (https://ci.genealabs.com/build-status/view/7)
15+
- [ ] All code must past PHPCS and PHPMD PSR2 validation.
16+
17+
## Submitting changes
18+
When submitting a pull request, it is important to make sure to complete the following:
19+
- [ ] Add a descriptive header that explains in a single scentence what problem the PR solves.
20+
- [ ] Add a detailed description with animated screengrab GIFs vidualizing how it works.
21+
- [ ] Explain why you think it should be implemented one way vs. another, highlight performance improvements, etc.
22+
23+
## Coding conventions
24+
Start reading our code and you'll get the hang of it. We optimize for readability:
25+
- indent using four spaces (soft tabs)
26+
- use Blade for all views
27+
- avoid logic in views, put it in controllers or service classes
28+
- ALWAYS put spaces after list items and method parameters (`[1, 2, 3]`, not `[1,2,3]`), around operators (`x += 1`, not `x+=1`), and around hash arrows.
29+
- this is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.
30+
- emphasis readability of code over patterns to reduce mental debt
31+
- always add an empty line around structures (if statements, loops, etc.)
32+
33+
Thanks!
34+
Mike Bronner, GeneaLabs

ISSUE_TEMPLATE.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Issue
2+
*summarize your issue here*
3+
4+
## Environment
5+
Laravel Version: *x.y.z*
6+
Laravel Messenger Package Version: *x.y.z*
7+
PHP Version: *x.y.z*
8+
Homestead Version: *x.y*
9+
Operating System & Version: *name x.y.z*
10+
11+
## Stack Trace
12+
- [ ] I have cleared my Laravel log file.
13+
- [ ] I have then reproduced my issue.
14+
- [ ] I have copied the __first__ listed stack trace from the fresh log file.
15+
16+
```
17+
*paste the first stack trace here*
18+
```

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
** DO NOT INSTALL -- STILL IN EXPERIMENTAL STAGE**
22

3-
# Laravel-cached-models
3+
# Model Caching for Laravel
4+
[![Travis](https://img.shields.io/travis/GeneaLabs/laravel-model-caching.svg)](https://travis-ci.org/GeneaLabs/laravel-model-caching)
5+
[![SensioLabs Insight](https://img.shields.io/sensiolabs/i/fde269ac-c382-4d17-a647-c69ad6b9dd85.svg)](https://insight.sensiolabs.com/projects/fde269ac-c382-4d17-a647-c69ad6b9dd85)
6+
[![Scrutinizer](https://img.shields.io/scrutinizer/g/GeneaLabs/laravel-model-caching.svg)](https://scrutinizer-ci.com/g/GeneaLabs/laravel-model-caching)
7+
[![Coveralls](https://img.shields.io/coveralls/GeneaLabs/laravel-model-caching.svg)](https://coveralls.io/github/GeneaLabs/laravel-model-caching)
8+
[![GitHub (pre-)release](https://img.shields.io/github/release/GeneaLabs/laravel-model-caching/all.svg)](https://github.com/GeneaLabs/laravel-model-caching)
9+
[![Packagist](https://img.shields.io/packagist/dt/GeneaLabs/laravel-model-caching.svg)](https://packagist.org/packages/genealabs/laravel-model-caching)
410

511
## Features
612
- automatic relationship caching.

0 commit comments

Comments
 (0)