Skip to content

Commit 5a406a8

Browse files
committed
Prepare for release version 1.0.0
1 parent b5ce0af commit 5a406a8

25 files changed

+341
-519
lines changed

.github/FUNDING.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: :vendor_name
1+
github: coding-wisely

.github/ISSUE_TEMPLATE/config.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Ask a question
4-
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=q-a
4+
url: https://github.com/coding-wisely/Commitvel/discussions/new?category=q-a
55
about: Ask the community for help
66
- name: Request a feature
7-
url: https://github.com/:vendor_slug/:package_name/discussions/new?category=ideas
7+
url: https://github.com/coding-wisely/Commitvel/discussions/new?category=ideas
88
about: Share ideas for new features
99
- name: Report a security issue
10-
url: https://github.com/:vendor_slug/:package_name/security/policy
10+
url: https://github.com/coding-wisely/Commitvel/security/policy
1111
about: Learn how to notify us for sensitive bugs

.github/workflows/phpstan.yml

-28
This file was deleted.

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# Changelog
22

3-
All notable changes to `:package_name` will be documented in this file.
3+
All notable changes to `Commitvel` will be documented in this file.

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) :vendor_name <author@domain.com>
3+
Copyright (c) coding-wisely <vladimir@codingwisely.com>
44

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

README.md

+41-25
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,40 @@
1-
# :package_description
2-
3-
[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
4-
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
5-
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
6-
[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
7-
<!--delete-->
8-
---
9-
This repo can be used to scaffold a Laravel package. Follow these steps to get started:
10-
11-
1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
12-
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
13-
3. Have fun creating your package.
14-
4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
15-
---
16-
<!--/delete-->
17-
This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
1+
# Commitvel- your git commit friendly tool! 🚀
2+
3+
4+
[![Latest Version on Packagist](https://img.shields.io/packagist/v/coding-wisely/commitvel.svg?style=flat-square)](https://packagist.org/packages/coding-wisely/commitvel)
5+
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/coding-wisely/commitvel/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/coding-wisely/commitvel/actions?query=workflow%3Arun-tests+branch%3Amain)
6+
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/coding-wisely/commitvel/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/coding-wisely/commitvel/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
7+
[![Total Downloads](https://img.shields.io/packagist/dt/coding-wisely/commitvel.svg?style=flat-square)](https://packagist.org/packages/coding-wisely/commitvel)
8+
9+
10+
Commitvel is a tailor-made package for Laravel developers to streamline their git workflow, ensuring code quality and efficiency without relying on git hooks. With a simple console command, Commitvel automates the mundane tasks of preparing your code for version control. Here's what Commitvel brings to the table:
11+
12+
13+
## Key Features:
14+
15+
### Change Detection:
16+
Effortlessly identifies and stages your code changes. 📋 Commitvel manually detects your changes, ensuring no modification goes unnoticed.
17+
18+
### Code Fixing with Laravel Pint:
19+
Automatically formats and styles your code with Laravel Pint. 🧼 Say goodbye to manual code styling—Commitvel makes your code shine with one command.
20+
21+
### Automated Unit Tests:
22+
23+
Executes your unit tests to guarantee code reliability. 🔍 Commitvel integrates with Pest to run tests, giving you peace of mind that your changes won't break existing functionality.
24+
25+
### Smart Committing:
26+
27+
Helps you compose meaningful commit messages and stages your code changes for you. 📝 Commitvel guides you through the process, ensuring your git history is clean and informative.
28+
29+
### Seamless Pushing:
30+
31+
Pushes your commits to the remote repository effortlessly. 🌐 Commitvel makes git pushing as simple as a single command, freeing you from the intricacies of git.
32+
33+
1834

1935
## Support us
2036

21-
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
37+
[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/Commitvel.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/Commitvel)
2238

2339
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
2440

@@ -29,20 +45,20 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh
2945
You can install the package via composer:
3046

3147
```bash
32-
composer require :vendor_slug/:package_slug
48+
composer require coding-wisely/commitvel
3349
```
3450

3551
You can publish and run the migrations with:
3652

3753
```bash
38-
php artisan vendor:publish --tag=":package_slug-migrations"
54+
php artisan vendor:publish --tag="commitvel-migrations"
3955
php artisan migrate
4056
```
4157

4258
You can publish the config file with:
4359

4460
```bash
45-
php artisan vendor:publish --tag=":package_slug-config"
61+
php artisan vendor:publish --tag="commitvel-config"
4662
```
4763

4864
This is the contents of the published config file:
@@ -55,14 +71,14 @@ return [
5571
Optionally, you can publish the views using
5672

5773
```bash
58-
php artisan vendor:publish --tag=":package_slug-views"
74+
php artisan vendor:publish --tag="commitvel-views"
5975
```
6076

6177
## Usage
6278

6379
```php
64-
$variable = new VendorName\Skeleton();
65-
echo $variable->echoPhrase('Hello, VendorName!');
80+
$commitvel = new CodingWisely\Commitvel();
81+
echo $commitvel->echoPhrase('Hello, CodingWisely!');
6682
```
6783

6884
## Testing
@@ -85,7 +101,7 @@ Please review [our security policy](../../security/policy) on how to report secu
85101

86102
## Credits
87103

88-
- [:author_name](https://github.com/:author_username)
104+
- [Vladimir Nikolic](https://github.com/coding-wisely)
89105
- [All Contributors](../../contributors)
90106

91107
## License

composer.json

+20-19
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
{
2-
"name": ":vendor_slug/:package_slug",
3-
"description": ":package_description",
2+
"name": "coding-wisely/commitvel",
3+
"version": "1.0.0",
4+
"description": "A Laravel package to assist with Git operations and code quality checks.",
45
"keywords": [
5-
":vendor_name",
6+
"coding-wisely",
7+
"git hooks",
8+
"pre-commit",
9+
"phppest",
10+
"laravel pint",
11+
"pre-commit hook",
612
"laravel",
7-
":package_slug"
13+
"commitvel"
814
],
9-
"homepage": "https://github.com/:vendor_slug/:package_slug",
15+
"homepage": "https://github.com/coding-wisely/commitvel",
1016
"license": "MIT",
1117
"authors": [
1218
{
13-
"name": ":author_name",
14-
"email": "author@domain.com",
19+
"name": "Coding Wisely",
20+
"email": "vladimir@codingwisely.com",
1521
"role": "Developer"
1622
}
1723
],
@@ -23,31 +29,26 @@
2329
"require-dev": {
2430
"laravel/pint": "^1.14",
2531
"nunomaduro/collision": "^8.1.1||^7.10.0",
26-
"larastan/larastan": "^2.9",
2732
"orchestra/testbench": "^9.0.0||^8.22.0",
2833
"pestphp/pest": "^2.34",
2934
"pestphp/pest-plugin-arch": "^2.7",
30-
"pestphp/pest-plugin-laravel": "^2.3",
31-
"phpstan/extension-installer": "^1.3",
32-
"phpstan/phpstan-deprecation-rules": "^1.1",
33-
"phpstan/phpstan-phpunit": "^1.3",
34-
"spatie/laravel-ray": "^1.35"
35+
"pestphp/pest-plugin-laravel": "^2.3"
3536
},
3637
"autoload": {
3738
"psr-4": {
38-
"VendorName\\Skeleton\\": "src/",
39-
"VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
39+
"CodingWisely\\Commitvel\\": "src/",
40+
"CodingWisely\\Commitvel\\Database\\Factories\\": "database/factories/"
4041
}
4142
},
4243
"autoload-dev": {
4344
"psr-4": {
44-
"VendorName\\Skeleton\\Tests\\": "tests/",
45+
"CodingWisely\\Commitvel\\Tests\\": "tests/",
4546
"Workbench\\App\\": "workbench/app/"
4647
}
4748
},
4849
"scripts": {
4950
"post-autoload-dump": "@composer run prepare",
50-
"clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
51+
"clear": "@php vendor/bin/testbench package:purge-commitvel --ansi",
5152
"prepare": "@php vendor/bin/testbench package:discover --ansi",
5253
"build": [
5354
"@composer run prepare",
@@ -73,10 +74,10 @@
7374
"extra": {
7475
"laravel": {
7576
"providers": [
76-
"VendorName\\Skeleton\\SkeletonServiceProvider"
77+
"CodingWisely\\Commitvel\\CommitvelServiceProvider"
7778
],
7879
"aliases": {
79-
"Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
80+
"Commitvel": "CodingWisely\\Commitvel\\Facades\\Commitvel"
8081
}
8182
}
8283
},

config/commitvel.php

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?php
2+
3+
// config for CodingWisely/Commitvel
4+
return [
5+
6+
];

config/skeleton.php

-6
This file was deleted.

0 commit comments

Comments
 (0)