Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Excellence #289

Merged
merged 20 commits into from
May 8, 2020
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

[*.yml]
indent_size = 2
13 changes: 5 additions & 8 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
# Auto detect text files and perform LF normalization
* text=auto

# Export ignores
.github export-ignore
tests export-ignore
/tests export-ignore
ziggy-banner.png export-ignore
CONTRIBUTING.md export-ignore
.gitattributes export-ignore
.babelrc export-ignore
.travis.yml export-ignore
package.json export-ignore
package-lock.json export-ignore
.editorconfig export-ignore
.gitattributes export-ignore
.github export-ignore
.gitignore export-ignore
phpunit.xml.dist export-ignore
webpack.config.js export-ignore
39 changes: 24 additions & 15 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,36 @@
### Expected Behavior
_If this is a new feature, give a usage example._
### Expected behavior

### Current Behavior
_If this is a new feature, is it a modification of an existing feature? Otherwise – `none`_
<!-- If this is a feature request/suggestion, please provide a usage example. -->

## For bug reports only please provide
### Currently installed Laravel version:
`5.5.28`
### Current behavior

### Currently installed Ziggy version
`0.6.0`
<!-- If this is a feature request/suggestion, is it a modification of an existing feature? If not, leave this blank. -->


<!-- For bug reports, please also fill out the section below: -->

### Versions

- **Laravel**: #.#.#
- **Ziggy**: #.#.#

### Route

<!-- The route with the issue, from your Laravel routes file, or a similar example. -->

### Example route from your Laravel Routes file.
_i.e. -_
```php
Route::get('/venues/{venue}', 'VenuesController@show')->name('venues.show');
```
### Contents of Ziggy.namedRoutes
_In dev tools type `Ziggy.namedRoutes` and copy the result here._

### Contents of `Ziggy.namedRoutes`

<!-- In your browser console/dev tools, type `Ziggy.namedRoutes` and paste the result here. -->

### Ziggy call in context
_i.e. –_

<!-- For example: -->

```javascript
// Api client is a wrapper around Axios
ApiClient.get(route('venues.show', {venue: 1}));
ApiClient.get(route('venues.show', { venue: 1 }));
```
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ jobs:
run: |
composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
composer update --prefer-dist --no-interaction --no-progress --no-suggest
npm ci
npm install

- name: Build
run: npm run build
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.idea/
node_modules/
vendor/
*.log
composer.lock
package-lock.json
phpunit.xml
node_modules/
*.log
36 changes: 28 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,40 @@
# Contribute like a pro!
# Contributing

Thanks for your interest in contributing to Ziggy! To keep things running smoothly we ask you to follow a few guidelines when contributing.
Thanks for your interest in contributing to Ziggy! Contributions are **welcome** and will be fully **credited**.

## Open an Issue first.
To keep things running smoothly we ask you to follow a few guidelines when contributing. Please read and understand this contribution guide before creating an issue or pull request.

## Etiquette

Be kind.

## Viability

If you have an idea for a feature, we'd prefer you open an issue before going to the trouble if writing code. We welcome your ideas, but we'd like to work with you to come up with solutions that work well for the project as a whole. We're usually pretty responsive, so it shouldn't take us long to figure out whether and how best to implement your idea.

## Name commits like we name commits.
## Procedure

Before filing an issue:

Just for the sake of easy readability we like to name commits and Pull requests in "imperetive present tense." This means the name should start with a verb describing what you are doing (in present tense). All the titles in this document are in imperitive present tense :smile:
- Attempt to replicate the problem, to ensure that it wasn't a coincidence
- Check to make sure your feature suggestion isn't already present within the project
- Check the pull requests tab to ensure that your feature or bugfix isn't already in progress

Example: `Add parameters to routes` instead of `Added parameters to routes` or `Adding parameters to routes`.
Before submitting a pull request:

## Write tests.
- Check the codebase to ensure that your feature doesn't already exist
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix

We use [Orchestra Testbench](http://orchestraplatform.com/docs/latest/components/testbench/) as our base Phpunit TestCase for testing PHP and [Mocha](https://mochajs.org) for testing our JavaScript.
## Tests

Please write tests for any fixes or new features you contribute. We use [Orchestra Testbench](http://orchestraplatform.com/docs/latest/components/testbench/) as our base PHPUnit test for PHP and [Mocha](https://mochajs.org) for testing our JavaScript.

You can run PHP tests with `vendor/bin/phpunit` and JavaScript tests with `npm run test`.

If you need any help with this please don't hesitate to ask.

## Requirements

- **[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](https://pear.php.net/package/PHP_CodeSniffer).
- **Tlint styles** - Tighten-specific styles. Tlint is built for apps, so there are some settings that might not make sense in a package, but [download Tlint](https://github.com/tightenco/tlint) and run it on your pull requests to see if it suggests any reasonable changes.
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License
The MIT License (MIT)

Copyright (c) Tighten Co.
Copyright (c) Tighten Co. <hello@tighten.co>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Loading