Contributing

Thank you for thinking about contributing to Teft!

Pull Requests

1. Check out a new feature branch locally.
2. Make your changes, testing thoroughly.
3. Commit your changes when you’re happy with them, and push the branch.
4. Open your pull request.

Thing so remember in a pull request:

• Update the changelog. Changes should be below a ## Unreleased title. If the unreleased title don’t exists, create it.
• Do not update version numbers in pull request. Our release script will handle it.

Adding a new plugin

• Add documentation.
• All plugins should contain a CHANGELOG.md
• Add the new plugin to the .wp-env.json file.
• Version number should be 0.0.0. The release script will set the version on first release.

Getting Started

Local Environment

First, you need a WordPress Environment to run Teft on. The quickest way to get up and running is to use wp-env.

In the folder of your preference, clone this project and enter the working directory:

# Clone the repo
git clone [email protected]:DekodeInteraktiv/teft.git

# Go into the cloned repo
cd teft

# Install dependencies and build plugins and styles
npm install
npm run build

# Start wp env
npm run wp-env start

Default URL: http://localhost:8889

WordPress credentials:
Username: admin
Password: password

Troubleshooting

See “wp-env - troubleshooting common problems”.

Building plugins

Scripts

npm run dev

Will build and watch for changes in all the plugins and the them.

npm run build

Will build a production files for all the plugins and the theme.