Merge pull request #66 from crowdfavorite/1.3.0

1.3.0

.github/CONTRIBUTING.md

@@ -0,0 +1,194 @@
+# Contributing to WP Capsule
+
+Looking to contribute something to WP Capsule? **Here's how you can help.**
+
+Please take a moment to review this document in order to make the contribution
+process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of
+the developers managing and developing this open source project. In return,
+they should reciprocate that respect in addressing your issue or assessing
+patches and features.
+
+
+## Using the issue tracker
+
+The [issue tracker](https://github.com/crowdfavorite/wp-capsule/issues) is
+the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests)
+and [submitting pull requests](#pull-requests), but please respect the following
+restrictions:
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.
+
+* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
+  Use [GitHub's "reactions" feature](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
+  instead. We reserve the right to delete comments which violate this rule.
+
+* Please **do not** open issues regarding [WP Capsule Server](https://github.com/crowdfavorite/wp-capsule-server/).
+
+
+## Issues and labels
+
+Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:
+
+- `good first issue` - GitHub will help potential first-time contributors discover issues that have this label.
+- `bug` - Issues that have been confirmed with a reduced test case and identify a bug in WP Capsule.
+- `css` - Issues stemming from our compiled CSS or source Sass files.
+- `docs` - Issues for improving or updating our documentation.
+- `feature` - Issues asking for a new feature to be added, or an existing one to be extended or modified.
+- `help wanted` - Issues we need or would love help from the community to resolve.
+- `js` - Issues stemming from our compiled or source JavaScript files.
+- `meta` - Issues with the project itself or our GitHub repository.
+- `duplicate` - This issue or pull request already exists.
+- `question` - General support/questions issue bucket.
+
+For a complete look at our labels, see the [project labels page](https://github.com/crowdfavorite/wp-capsule/labels).
+
+
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.
+Good bug reports are extremely helpful, so thanks!
+
+Guidelines for bug reports:
+
+0. **Validate your code** to ensure your
+   problem isn't caused by a simple error in your own code.
+
+1. **Use the GitHub issue search** — check if the issue has already been
+   reported.
+
+2. **Check if the issue has been fixed** — try to reproduce it using the
+   latest `master` or `develop` branch in the repository.
+
+3. **Isolate the problem** — ideally create or record a live example.
+
+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment(installed plugins, WordPress version, WP Capsule version)? What steps will reproduce the issue? What browser(s) and serverstack
+experience the problem? What
+would you expect to be the outcome? All these details will help people to fix
+any potential bugs.
+
+Example:
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/serverstack/WordPress environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea
+fits with the scope and aims of the project. It's up to *you* to make a strong
+case to convince the project's developers of the merits of this feature. Please
+provide as much detail and context as possible.
+
+
+## Pull requests
+
+Good pull requests—patches, improvements, new features—are a fantastic
+help. They should remain focused in scope and avoid containing unrelated
+commits.
+
+**Please ask first** before embarking on any significant pull request (e.g.
+implementing features, refactoring code), otherwise you risk spending
+a lot of time working on something that the project's developers
+might not want to merge into the project.
+
+Please adhere to the [coding guidelines](#code-guidelines) used throughout the
+project (indentation, accurate comments, etc.) and any other requirements
+(such as test coverage).
+
+**Do not edit compiled assets or vendor dependencies directly!**
+Those files are either automatically generated in the case of js or css assets
+or ignored from the repo codebase in the case of dependencies(`vendor` AND `ui` folder).
+You should edit the source files for assets or extend vendor dependencies.
+
+Adhering to the following process is the best way to get your work
+included in the project:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
+   and configure the remotes:
+
+   ```bash
+   # Clone your fork of the repo into the current directory
+   git clone https://github.com/<your-username>/wp-capsule.git
+   # Navigate to the newly cloned directory
+   cd wp-capsule
+   # Assign the original repo to a remote called "upstream"
+   git remote add upstream https://github.com/crowdfavorite/wp-capsule.git
+   ```
+
+2. If you cloned a while ago, get the latest changes from upstream:
+
+   ```bash
+   git checkout develop
+   git pull upstream develop
+   ```
+
+3. Create a new topic branch (off the main project `develop` branch) to
+   contain your feature, change, or fix:
+
+   ```bash
+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [git commit
+   message guidelines](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+   or your code is unlikely be merged into the main project. Use Git's
+   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
+   feature to tidy up your commits before making them public.
+
+5. Locally merge (or rebase) the upstream `develop` branch into your topic branch:
+
+   ```bash
+   git pull [--rebase] upstream develop
+   ```
+
+6. Push your topic branch up to your fork:
+
+   ```bash
+   git push origin <topic-branch-name>
+   ```
+
+7. [Open a Pull Request](https://help.github.com/articles/about-pull-requests/)
+    with a clear title and description against the `develop` branch.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owners to
+license your work under the terms of the [GPLv2 License](../LICENSE).
+
+
+## Code guidelines
+
+### PHP
+WP Capsule repos follow an extended [PSR12 ruleset](../phpcs.xml) that includes WordPress Security sniffs with the added change of preffering tabs instead of spaces for indentation.
+**You code should adhere to this ruleset.**
+
+### CSS
+- Classes should be named following the [BEM conventions](http://getbem.com/naming/).
+- Your compiled CSS should nest no more than 4 levels deep, preferably no more than 3 levels.
+- Follow [ITCSS](https://www.creativebloq.com/web-design/manage-large-css-projects-itcss-101517528) principles for organizing styles.
+
+### JS
+We adhere to the [AirBnB JavaScript Style Guide](https://github.com/airbnb/javascript) for project JavaScript code. [All rules apply](https://github.com/airbnb/javascript/blob/master/README.md#table-of-contents) with the following exceptions:
+- Ignore rules related to IE8 support. We don't generally do it, and sometimes it can be useful to use a normal property overridden into a different one (such as a CSS styles object to pass to jQuery).
+- Put all functions at the end of scope, possibly after a return. Doing this comes from the Angular guide, and makes it easier to follow a narrative flow of the code. We see the behaviors, then can quickly dig into the implementation if we wish to. (Credit to [John Papa's Angular Style guide](https://github.com/johnpapa/angular-styleguide) for this idea)
+
+### Checking coding style
+Run `phpcs --standard=phpcs.xml` before committing to ensure your changes follow our coding standards.
+
+## License
+By contributing your code, you agree to license your contribution under the [GPLv2 License](../LICENSE).

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: Tell us about a bug you may have identified in WP Capsule.
+labels: bug
+---
+
+Before opening:
+
+- [Search for duplicate or closed issues](https://github.com/crowdfavorite/wp-capsule/issues?utf8=%E2%9C%93&q=is%3Aissue)
+- Validate and [lint](https://github.com/crowdfavorite/wp-capsule/blob/master/phpcs.xml) any PHP code to avoid common problems
+- Read the [contributing guidelines](https://github.com/crowdfavorite/wp-capsule/blob/master/.github/CONTRIBUTING.md)
+
+Bug reports must include:
+
+- Operating system and version (Windows, macOS, Android, iOS, Win10 Mobile)
+- Browser and version (Chrome, Firefox, Safari, IE, MS Edge, Opera 15+, Android Browser)
+- Serverstack(with versions) and WordPress environment(WP Capsule version, WordPress version, installed plugins, multi or single site)
+- Ideally create or record a live example of the bug

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,15 @@
+---
+name: Feature request
+about: Suggest an idea for a new feature in WP Capsule.
+labels: feature
+---
+
+Before opening:
+
+- [Search for duplicate or closed issues](https://github.com/crowdfavorite/wp-capsule/issues?utf8=%E2%9C%93&q=is%3Aissue)
+- Read the [contributing guidelines](https://github.com/crowdfavorite/wp-capsule/blob/master/.github/CONTRIBUTING.md)
+
+Feature requests must include:
+
+- As much detail as possible for what we should add and why it's important to WP Capsule
+- Relevant resources wherever possible

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Description
+<!-- Describe what you have changed or added. -->
+<!-- Link to the issue(s) where appropriate. -->
+
+## Testing instructions
+<!-- Add instructions to help the reviewer test your code. -->
+<!-- Include sample forms, add-ons or snippets where appropriate. -->
+
+## Screenshots
+<!-- if applicable -->
+
+## Checklist:
+- [ ] I've tested the code.
+- [ ] My code follows the WP Capsule custom PSR12 code style. <!-- Ruleset: https://github.com/crowdfavorite/wp-capsule/blob/master/phpcs.xml/ -->
+- [ ] My code follows the accessibility standards. <!-- Guidelines: https://make.wordpress.org/core/handbook/best-practices/coding-standards/accessibility-coding-standards/ -->
+- [ ] My code follows the PHP DocBlock documentation standards. <!-- Resource: https://docs.phpdoc.org/guides/docblocks.html -->

.github/SUPPORT.md

@@ -0,0 +1,7 @@
+### Bug reports
+
+See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.
+
+### How-to
+
+For general troubleshooting or help getting started please open an issue in this repo and label it as "Question".

CHANDELOG.md

@@ -0,0 +1,48 @@
+## Version 1.3.0
+- fixed warning when editing posts in the backend
+- replace icon
+- rewrite URLs to SSL variants(https)
+- PSR-12 code style enforce
+- fixed a bug where projects and tags were being registered from codeblocks or docblocks
+- fixed a bug where `` $` `` or `$'` broke the codeblock interface
+- Added "open in new" icon to webfont files. Updated how icons are added. Improved accessibility of main menu and articles utility menu items.
+- update issue templates to add labels
+- update php-markdown lib to ignore parsing of heading tags without a space eg: #test
+- added phpcs ruleset, license file, security policy, code of conduct, contributing guidelines, changelog file, templates for pull requests and issues, support information
+- Replaced wp_redirect with wp_safe_redirect
+- Replaced wp_remote_* with wp_safe_remote_*
+- updated documentation
+- added wp-capsule-ui as a git subtree, removing 3rd-party git subrepo usage
+
+## Version 1.2
+- remove the git submodules structure
+- update libraries, code cleanup
+- fix various PHP notices
+
+## Version 1.1.1
+- include jQuery Hotkeys in the optimized.js file
+
+## Version 1.1
+- add keyboard shortcuts for Home, New Post, focus to Search field
+- background queue for sending posts to Capsule Server (saves are now non-blocking UI actions, also supports offline usage)
+- add favicon and icon for use with Fluid app
+- add default styling for tables
+- show which servers a post has been pushed to, with link to post on server
+- allow mapping of multiple local projects to a single server project
+- fix issues with syntax highlighting markdown emphasis in editor versus display
+- fix double-encoding of ampersands on display
+- fix fenced code blocks not being entity-encoded in some cases
+- don't allow the same Capsule Server to be added twice
+- fix auth check (prevent direct access to posts)
+- remove persistent horizontal scrollbar from code blocks (now only appears when needed)
+- add hooks in Capsule's controllers for extensibility (capsule_controller_action_get, capsule_controller_action_post)
+- add filter to allow overriding of Capsule's access restrictions (capsule_gatekeeper_enabled)
+- add before and after actions to post menu (capsule_post_menu_before, capsule_post_menu_after)
+- add before and after actions to main nav (capsule_main_nav_before, capsule_main_nav_after)
+- update WP permalinks when pretty premalinks are detected and our custom taxonomies are not present
+- explicitly remove post formats support
+- fix various PHP notices
+
+## Version 1.0
+
+- initial release

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## 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 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq