From 20771e002ed62372db00ba9e1ca726b36c0e4ed8 Mon Sep 17 00:00:00 2001 From: Dmitry Khomutov Date: Sat, 24 Feb 2018 12:10:00 +0700 Subject: [PATCH 1/2] Documentation improvements. --- CHANGELOG.md | 2 +- README.md | 14 +++++--- docs/en/README.md | 87 +++++++++++++++++++++++++++++++---------------- 3 files changed, 68 insertions(+), 35 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 29fbd03c..4f77cb7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,7 +31,7 @@ Pull request [#142](https://github.com/php-censor/php-censor/pull/142). - Application Cache class and replaced by Symfony/Cache component. - Useless Template class and refactored View. -- User model from $_SESSION. +- User model from `$_SESSION`. ### Fixed diff --git a/README.md b/README.md index 6139a136..3d3f95ed 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,14 @@ More [screenshots](docs/en/screenshots.md). * Database (MySQL/MariaDB or PostgreSQL); -* Beanstalkd queue (Optional); +* Beanstalkd queue (Optional, needed if you use [worker](docs/en/workers/worker.md) instead of +[cronjob](docs/en/workers/cron.md)); ## Features -* Clone project from GitHub, Bitbucket, GitLab, Git, Mercurial, SVN or from local directory; +* Clone project from [GitHub](docs/en/sources/github.md), [Bitbucket](docs/en/sources/bitbucket.md) (Git/Hg), +[GitLab](docs/en/sources/gitlab.md), [Git](docs/en/sources/git.md), Hg (Mercurial), SVN (Subversion) or from local +directory; * Set up and tear down database tests for [PostgreSQL](docs/en/plugins/pgsql.md), [MySQL](docs/en/plugins/mysql.md) or [SQLite](docs/en/plugins/sqlite.md); @@ -58,10 +61,11 @@ More [screenshots](docs/en/screenshots.md). * Check code via Lint, PHPParallelLint, Pdepend, PHPCodeSniffer, PHPCpd, PHPCsFixer, PHPDocblockChecker, PHPLoc, PHPMessDetect, PHPTalLint and TechnicalDept; -* Run through any combination of the other [supported plugins](docs/en/README.md#plugins), including Campfire, CleanBuild, -CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe; +* Run through any combination of the other [supported plugins](docs/en/README.md#plugins), including Campfire, +CleanBuild, CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe; -* Send notifications on Email, XMPP, Slack, IRC, Flowdock, HipChat and [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin); +* Send notifications on Email, XMPP, Slack, IRC, Flowdock, HipChat and +[Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin); * Use your LDAP-server for authentication; diff --git a/docs/en/README.md b/docs/en/README.md index 1deef8b5..789f6757 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -16,10 +16,14 @@ Using PHP Censor ---------------- * Automatically building commits pushed to - * [Github](sources/github.md) - * [Bitbucket](sources/bitbucket.md) - * [GitLab](sources/gitlab.md) * [Git](sources/git.md) + * [Github (Git)](sources/github.md) + * [Bitbucket (Git)](sources/bitbucket.md) + * [GitLab (Git)](sources/gitlab.md) + * Gogs (Git) + * Mercurial/Hg + * Bitbucket (Hg) + * Subversion/Svn * [Injecting variables into messages](interpolation.md) * [Project Status Images and Status Page](status.md) * [Build environments](environments.md) @@ -29,29 +33,23 @@ Plugins ### Internal plugins +#### Dependencies + +* [Composer](plugins/composer.md) - `composer` +* [Security Checker](plugins/security_checker.md) - SensioLabs Security Checker Plugin (`security_checker`). + +#### Tests + * [Atoum](plugins/atoum.md) - `atoum` * [Behat](plugins/behat.md) - `behat` -* [Campfire](plugins/campfire.md) - `campfire` -* [Clean Build](plugins/clean_build.md) - `clean_build` * [Codeception](plugins/codeception.md) - `codeception` -* [Composer](plugins/composer.md) - `composer` -* [Copy Build](plugins/copy_build.md) - `copy_build` -* [Deployer](plugins/deployer.md) - `deployer` -* [Email](plugins/email.md) - `email` -* [Env](plugins/env.md) - `env` -* [Grunt](plugins/grunt.md) - `grunt` -* [Hipchat](plugins/hipchat_notify.md) - `hipchat_notify` -* [IRC](plugins/irc.md) - `irc` +* [PHP Unit](plugins/php_unit.md) - `php_unit` +* [PHP Spec](plugins/php_spec.md) - `php_spec` + +#### Code style + * [Lint](plugins/lint.md) - `lint` -* [Mage](plugins/mage.md) - `mage` -* [Mage v3](plugins/mage3.md) - `mage3` -* [MySQL](plugins/mysql.md) - `mysql` -* [Package Build](plugins/package_build.md) - `package_build` * [PDepend](plugins/pdepend.md) - `pdepend` -* [PostgreSQL](plugins/pgsql.md) - `pgsql` -* [SQLite](plugins/sqlite.md) - `sqlite` -* [Phar](plugins/phar.md) - `phar` -* [Phing](plugins/phing.md) - `phing` * [PHP Code Sniffer](plugins/php_code_sniffer.md) - `php_code_sniffer` * [PHP Copy/Paste Detector](plugins/php_cpd.md) - `php_cpd` * [PHP Coding Standards Fixer](plugins/php_cs_fixes.md) - `php_cs_fixer` @@ -59,17 +57,48 @@ Plugins * [PHP Loc](plugins/php_loc.md) - `php_loc` * [PHP Mess Detector](plugins/php_mess_detector.md) - `php_mess_detector` * [PHP Parallel Lint](plugins/php_parallel_lint.md) - `php_parallel_lint` -* [PHP Spec](plugins/php_spec.md) - `php_spec` -* [PHP Unit](plugins/php_unit.md) - `php_unit` -* [Shell](plugins/shell.md) - `shell` -* [Slack](plugins/slack_notify.md) - `slack_notify` +* PHP Tal Lint - `php_tal_lint` * [Technical Debt](plugins/technical_debt.md) - `technical_debt` -* [Security Checker](plugins/security_checker.md) - SensioLabs Security Checker Plugin (`security_checker`). + +#### Databases + +* [MySQL](plugins/mysql.md) - `mysql` +* [PostgreSQL](plugins/pgsql.md) - `pgsql` +* [SQLite](plugins/sqlite.md) - `sqlite` + +#### Deployment + +* [Mage](plugins/mage.md) - `mage` +* [Mage v3](plugins/mage3.md) - `mage3` +* [Phing](plugins/phing.md) - `phing` +* [Deployer](plugins/deployer.md) - `deployer` + +#### Notifications + +* [Campfire](plugins/campfire.md) - `campfire` +* [Email](plugins/email.md) - `email` +* FlowDock - `flowdock_notify` +* [HipChat](plugins/hipchat_notify.md) - `hipchat_notify` +* [IRC](plugins/irc.md) - `irc` +* [Slack](plugins/slack_notify.md) - `slack_notify` * [XMPP](plugins/xmpp.md) - `xmpp` +#### Other + +* [Clean Build](plugins/clean_build.md) - `clean_build` +* [Copy Build](plugins/copy_build.md) - `copy_build` +* [Env](plugins/env.md) - `env` +* Git - `git` +* [Grunt](plugins/grunt.md) - `grunt` +* Gulp - `gulp` +* [Package Build](plugins/package_build.md) - `package_build` +* [Phar](plugins/phar.md) - `phar` +* [Shell](plugins/shell.md) - `shell` +* Wipe - `wipe` + ### Third-party plugins -* [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin) - Telegram plugin by +* [Telegram](https://github.com/php-censor/php-censor-telegram-plugin) - Telegram plugin by [@LEXASOFT](https://github.com/LEXASOFT) -* [Deployer](https://github.com/ket4yii/phpcensor-deployer-plugin) - Plugin for [Deployer](http://deployer.org) by -[@ket4yii](https://github.com/ket4yii) +* [Deployer](https://github.com/php-censor/php-censor-deployer-plugin) - Plugin for [Deployer](http://deployer.org) by +[@ketchoop](https://github.com/ketchoop) From 9802e2b81c9c00783cf9146a13d3fc93c94fdfa5 Mon Sep 17 00:00:00 2001 From: Dmitry Khomutov Date: Mon, 5 Mar 2018 19:58:31 +0700 Subject: [PATCH 2/2] Improved ISSUE_TEMPLATE.md. --- CODE_OF_CONDUCT.md | 28 +++++++++++++++++++++------- ISSUE_TEMPLATE.md | 5 ++++- 2 files changed, 25 insertions(+), 8 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 77b1b3bf..44d94603 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,7 +2,10 @@ ## Our Pledge -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. +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. ## Our Standards @@ -24,23 +27,34 @@ Examples of unacceptable behavior by participants include: ## Our Responsibilities -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. +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. -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. +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. ## Scope -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. +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. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at poisoncorpsee@gmail.com. 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. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at +poisoncorpsee@gmail.com. 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. -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. +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. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at +[http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/ diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index c6209c0e..9c425047 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -12,4 +12,7 @@ ## Environment -*OS, PHP version, MySQL/PostgreSQL version.* +* PHP Censor version +* Operating System +* PHP version +* MySQL/PostgreSQL version