Skip to content

Latest commit

 

History

History
48 lines (28 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

48 lines (28 loc) · 3.02 KB
Raw

Contributing to the Quicklink for WordPress

Hi! Thank you for your interest in contributing to the plugin, we really appreciate it.

There are many ways to contribute – reporting bugs, feature suggestions, fixing bugs, submitting pull requests for enhancements.

Reporting Bugs, Asking Questions, Sending Suggestions

Just file a GitHub issue, that’s all. If you want to prefix the title with a “Question:”, “Bug:”, or the general area of the application, that would be helpful, but by no means mandatory. If you have write access, add the appropriate labels.

If you’re filing a bug, specific steps to reproduce are helpful. Please include the URL of the page that has the bug, along with what you expected to see and what happened instead.

Setting up the dev environment

If you want to contribute code to the theme you have to set up the environment locally. Make sure that you have npm and grunt installed.

The working directory is the build directory. If you change something in another location of the git the pull request or commit will be ignored. This repository uses @wordpress/env to provide a local development environment. Please refer to the documentation for wp-env to learn more about that package.

The development server and all dependencies are handled by docker and npm. Make sure you have docker-compose installed and run npm start in the directory. You spawned WordPress instance will be available under http://localhost:8888 with the account admin:password.

Please be aware, that you should usually not write code directly on the master branch.

Start the grunt watcher with the terminal command grunt watch. Grunt will make sure that the code will be compiled and copied to the trunk folder.

Before committing execute the command grunt deploy to perform a clean deploy from the build to the trunk folder.

IMPORTANT: Edits outside the build directory will be overwritten by the grunt tasks. So make sure you don't work within the trunk folder.

Development workflow

To keep the work in this repository structured and visible, we follow a certain way to add changes and code. A good workflow is structured like this:

  1. Write or take an issue about the problem you want to solve
  2. Add your own branch to the repository
  3. As soon as you have a presentable solution, add a pull request to the master branch
  4. Get feedback about your implementation
  5. Before merging the PR to the master branch, update your branch from master to resolve conflicts
  6. Merge the PR into the master branch and delete your branch

Naming branches

Ideally name your branches with prefixes and descriptions, like this: [type]/[change]. A good prefix would be:

  • add/ = add a new feature
  • try/ = experimental feature, "tentatively add"
  • update/ = update an existing feature

For example, add/gallery-block means you're working on adding a new gallery block.