Contribute

A quick guide to code contributing

Thank you for thinking of contributing to Planet4! 💚

The next few chapters will guide you through the very basic things you need to get started.

Development

Planet 4 consists of many repositories, for all the themes and plugins we develop:

Our code repositories built the platform we call Planet 4

Now pick the one you want to work on, and if you don't have write access to it, fork it on Github.

Pull Requests

Before working on something or opening a Pull Request, please make sure that there is a relevant issue:

  • If a relevant issue already exists, leave a comment that you are interested in working on that.

  • If no relevant issue exists, open a new one and initiate the discussion.

The tickets labeled as Contribution are a good starting point for start coding.

All Pull Requests should target the master branch. Make sure to reference the relevant issue in your Pull Request description and follow our git guidelines.

Coding

In general we try to stick as close as possible to WordPress Coding Standards. The best approach to make sure your code is following planet4’s coding style is to use code linters. Most code editors have integrations and plugins for linting the code in realtime. We already have linter configuration in our repositories. Here is a list of the linters we use:

Code Of Conduct

In the interest of fostering an open, inclusive and welcoming environment, our project is following a Contributor Code of Conduct.