↓Skip to main content
Dessky.org Dessky.org
  1. All Posts/

contributor-orientation-tool

Tools Open Source PHP WordPress

contributor-orientation-tool

A WordPress plugin aiming to help new contributors decide which make team/s to contribute to or join at Contributor Day.

Getting Started

Install node.js.

npm install

You are done.
Please not that you need to have webpack and webpack cli globally for ease of use.

npm run dev or npm run watch

Use npm run dev or npm run watch for on–the–fly updates of your code (templates, js, css)…

npm run prod

This will create a dist directory for project. This directory represents distribution package to zip and install on your WordPress site.

Directory Structure

Plese keep in mind that dist directory is rebuilt with each npm dev, npm watch or npm prod command.

dist/ [generated via webpack]
src/
├── languages/ [translation files]
├── src/ [images, stylesheets]
├────── WPCOTool/ [Namespace root]
├──────── Admin/
├──────── assets/ [images, stylesheets]
├──────── Frontend/
├── contributor-orientation-tool.php [WordPress plugin main file]
└── README.txt [WordPress plugin readme file]
.babelrc
.editorconfig
.eslintrc
.gitignore
.stylelintrc
LICENSE
package.json
README.md
webpack.config.js

Workflow

Workflow for adding new features is as follows:

  • Add new issue
  • Fork repository
  • Checkout new brancs with name feature/name-of-the-feature, usually name of the issue
  • Commit with message #{issue id} Name of the issue - description
  • Push to the forked repository
  • Create pull request to develop branch
  • Checkout to develop branch
  • Fetch upstream more info

Local Development environment setup

For local development please use VVV or Docker

  • Clone repository outside your WordPress installation plugins folder
  • Sync dist/contributor-orientation-tool to your instalation wp-content/plugins folder
  • Run npm run watch to start development
  • Note: Don’t make changes to dist folder as it is regenerated on every compile

Changing plugin version

Please note: If changing version of the plugin you need to modify version in this files:

  • src/README.txt (also add update description at the end of file for new version)
  • src/src/WPCOTool/Plugin.php (modify class property: $version)
  • src/contributor-orientation-tool.php (modify plugin header)

Plugin options

Plugin options are located under Settings admin menu.
Visit Settings -> Contributor orientation tool page and there you can disable teams that you don’t need.

Licence

The WordPress Widget Boilerplate is licensed under the GPL v2 or later.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Developers

Miss a feature? Pull requests are welcome.
Hopefully the project will receive contributions from awesome WordPress Developers throughout the world.



↑