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.

Sign up for GitHub

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

Rebrand to Alma Career Czechia in documentation and meta information #88

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Rebrand to Alma Career Czechia in documentation and meta information #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

<!-- We follow Semantic Versioning (http://semver.org/) and Keep a Changelog principles (http://keepachangelog.com/) -->
<!-- We follow Semantic Versioning (https://semver.org/) and Keep a Changelog principles (https://keepachangelog.com/) -->

<!-- There is always Unreleased section on the top. Subsections (Added, Changed, Fixed, Removed) should be added as needed. -->

Expand Down
2 changes: 1 addition & 1 deletion LICENCE.md → LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### The MIT License (MIT) ###

Copyright (c) 2018 LMC s.r.o.
Copyright (c) Alma Career Czechia s.r.o.

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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# LMC Coding Standard for PHP
# Alma Career Czechia Coding Standard for PHP

[![Latest Stable Version](https://img.shields.io/packagist/v/lmc/coding-standard.svg?style=flat-square)](https://packagist.org/packages/lmc/coding-standard)

PHP coding standard used in [LMC](https://www.lmc.eu/en/) projects.
PHP coding standard used in [Alma Career Czechia](https://www.almacareer.com/) (formerly LMC) products.

Standard is based on [PSR-12](https://www.php-fig.org/psr/psr-12/) and adds
various checks to make sure the code is readable, does follow the same conventions and does not contain common mistakes.
Expand All @@ -17,7 +17,7 @@ composer require --dev lmc/coding-standard

## Usage

1. Create `ecs.php` file in the root directory of your project and import the LMC code-style rules:
1. Create `ecs.php` file in the root directory of your project and import the code-style rules:

```php
<?php declare(strict_types=1);
Expand Down Expand Up @@ -74,7 +74,7 @@ Now you will be able to run the fix using `composer analyze` and execute automat
On top of default code-style rules you are free to add any rules from [PHP-CS-Fixer] or [PHP_CodeSniffer].
If needed, you can also override some default settings.

Be aware you must add these settings **after** import of the base LMC code-style:
Be aware you must add these settings **after** import of the base Alma Career Czechia (LMC) code-style:

```php
<?php declare(strict_types=1);
Expand Down Expand Up @@ -104,7 +104,7 @@ See [EasyCodingStandard docs](https://github.com/symplify/easy-coding-standard#c

You can configure your `ecs.php` to entirely skip some files, disable specific checks of suppress specific errors.

Unlike adding/modifying checks, skips must be added **before** import of the base LMC code-style.
Unlike adding/modifying checks, skips must be added **before** import of the base Alma Career Czechia (LMC) code-style.

```php
<?php declare(strict_types=1);
Expand Down Expand Up @@ -143,7 +143,7 @@ For integration with PHPStorm etc. follow instructions in EasyCodingStandard [RE
For latest changes see [CHANGELOG.md](CHANGELOG.md) file. We follow [Semantic Versioning](https://semver.org/).

## License
This library is open source software licensed under the [MIT license](LICENCE.md).
This library is open source software licensed under the [MIT license](LICENSE.md).

[PHP-CS-Fixer]: https://github.com/FriendsOfPHP/PHP-CS-Fixer
[PHP_CodeSniffer]: https://github.com/squizlabs/PHP_CodeSniffer
Expand Down
2 changes: 1 addition & 1 deletion UPGRADE-4.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ $ vendor/bin/ecs check --ansi # new
```

### 5. Sanity check
Besides running your code style checks, you can ensure all predefined LMC checks are loaded as well, by running:
Besides running your code style checks, you can ensure all predefined checks are loaded as well, by running:

```sh
vendor/bin/ecs list-checkers
Expand Down
6 changes: 3 additions & 3 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "lmc/coding-standard",
"description": "Coding standard used in LMC projects",
"description": "Coding standard used in Alma Career Czechia (LMC) projects",
"license": "MIT",
"type": "library",
"authors": [
{
"name": "LMC s.r.o.",
"homepage": "https://github.com/lmc-eu"
"name": "Alma Career",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"name": "Alma Career",
"name": "Alma Career Czechia",

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This refers to the name of the organization, which is Alma Career... I would keep this one as is (but I changed the README references as suggested).

"homepage": "https://github.com/almacareer/"
}
],
"require": {
Expand Down