Skip to content

Commit

Permalink
add all readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
greta-mik committed Sep 11, 2024
1 parent ce56f59 commit 01ae78a
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,43 @@
<h1>wp-omnisend-paid-memberships-pro</h1>
# wp-omnisend-lifterlms

Plugin for _LifterLMS_ WordPress plugin. More information can be found [here](https://wordpress.com/plugins/paid-memberships-pro).


## PHP Linting

WordPress.org team mandates our plugin to be linted
against [WordPress coding standards](https://github.com/WordPress/WordPress-Coding-Standards).

After each push to any branch `PHP Standards` action will run and all the PHP code will be linted. See action output for results.

### Linting locally

Tools needed:

- php (7.4 version is recommended because at the time of writing WordPress coding standards supports only up to 7.4 version);
- composer (can be installed as described in https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos);

After installing those tools one can run in local plugin dir (omnisend-for-contact-form-7) helper script:

```shell
./lint.sh check
./lint.sh fix
```

or all commands manually. Following commands

```shell
composer update
composer install
```

install linting tool and standards. And then actual linting `phpcs` script can be initiated with

```shell
./vendor/squizlabs/php_codesniffer/bin/phpcs --ignore=.js --standard=WordPress omnisend-connect
```

A second `phpcbf` script can be run to automatically correct coding standard violations:

```shell
./vendor/squizlabs/php_codesniffer/bin/phpcbf --ignore=.js --standard=WordPress omnisend-connect
2 changes: 1 addition & 1 deletion omnisend-for-paid-memberships-pro/readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Omnisend for Paid Memberships Pro - automatically sync contacts, new subscribers
== REQUIREMENTS ==

Omnisend for Paid Memberships Pro add-on requires you to install:
- [Paid Memberships Pro plugin](https://wordpress.com/plugins/xxxxx/)
- [Paid Memberships Pro plugin](https://wordpress.com/plugins/paid-memberships-pro/)
- [Omnisend plugin](https://wordpress.org/plugins/omnisend/)

== FAQ ==
Expand Down

0 comments on commit 01ae78a

Please sign in to comment.