Skip to content

Latest commit

 

History

History
173 lines (125 loc) · 6.21 KB

CONTRIBUTING.md

File metadata and controls

173 lines (125 loc) · 6.21 KB

Contributing to CC WordPress development

Thank you for your interest in contributing to CC WordPress Development! This document is a set of guidelines to help you contribute to this project.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

Project Documentation

Please consult the README for the complete project documentation.

How to Contribute

Make sure you have gone through our general Contributing Code guidelines on the Creative Common Open Source website.

Prerequisites

The technologies below must be installed locally in your computer:

  • Web Server: Apache or Nginx
  • Database: MySQL version 5.0.15 or greater or any version of MariaDB.
  • PHP: Version 7.3 or greater.
  • WordPress: Version 5.4 or greater

Development

Master branch is for the releases. Development will be done in the development branch. Occasionally other branches may be available to test new features or play with new ideas, but they may be deleted anytime so don't rely on those branches. To start contributing code, checkout the develop branch.

WordPress Coding Standards

Creative Commons plugin for WordPress follows WordPress Coding Standards and WordPress Documentation Standards. Before pushing your work/contribution, make sure it closely follows these standards otherwise it will not be accepted. We use a PHP_CodeSniffer setup with 'WordPress' sniff to check the code against the standards.

Recommended Setup for WordPress Coding Standards

If you are not setup to detect WPCS errors, consider the following steps.

  1. Install Composer

    Make sure that you have the current version of PHP installed. Then the first step is to install Composer. Install it Globally by following its documentation for your particular OS.

  2. Install PHP_CodeSniffer

    Install PHPCS by running the following command in your terminal:

    composer global require squizlabs/php_codesniffer

  3. Confirm Installation

    Check your installation by which phpcs, You should get the path to the phpcs executable. If you don't get anything for which phpcs, you need to add this to your .zshrc or .bash_profile (or your shell’s own profile file) so it will make terminal look in that folder too:

    export PATH="$HOME/.composer/vendor/bin:$PATH"

    If you are using a Linux distro e.g. Ubuntu add the path below to your .bashrc file:

    export PATH="$HOME/.config/composer/vendor/bin:$PATH"

  4. Setup WPCS

    Clone the official WordPress Coding Standards repository in your home folder. To do so, run the following commands: if using ssh

    cd
git clone git@github.com:WordPress-Coding-Standards/WordPress-Coding-Standards.git wpcs

    if using https

    git clone https://github.com/WordPress/WordPress-Coding-Standards.git

  5. Tell PHPCS about this directory

    We need to add the ~/wpcs folder, where we cloned wpcs, to the installed paths of phpcs. Replace the path with the path of your wpcs directory:

    phpcs --config-set installed_paths /Users/your-username/wpcs

  6. Check Installation

    Confirm that it is working by running the following command:

    phpcs -i

    The output should be:

    The installed coding standards are PEAR, Zend, PSR2, MySource, Squiz, PSR1,
PSR12, WordPress-VIP, WordPress, WordPress-Extra, WordPress-Docs and
WordPress-Core

    If it does not include the WordPress Standards, most probably the installed_paths config option is wrong. Make sure that it points to the right directory.

  7. Visual Studio Code Workflow

    To configure VSCode so that it may report errors right in the editor, install phpcs extension. Open User Settings and add the following settings:

    "phpcs.executablePath": "/usr/local/bin/phpcs",
"phpcs.standard": "WordPress"

    Now, phpcs will report errors inside VSCode. If you are using some other editor, consult its documentation. Once there are no reported errors in your fix, you are good to go.

Running the wp-theme-commoners locally

  • Fork this repository on GitHub.
  • Locally in your computer, open the wordpress directory in your text editor.
  • Then navigate to the themes directory by running the command below on your terminal:
cd wp-content/themes/wp-theme-commoners
  • Then clone your fork of this repository in the current directory.
  • After successfully cloning the project, navigate to the wp-theme-commoners directory and run the command below on the terminal, to install all the necessary package dependencies:
composer install

One of the installed dependencies is Queulat,in-order to initialize Queulat in the project follow the instruction provided in this link.

  • Then you can proceed to run your server and activate the wp-theme-commoners in your local WordPress environment. Happy Coding!

Questions or Thoughts?

Talk to us on our developer mailing list or Slack community.