craftcms / craftcms/docs

Improve “Setting Up Tests”

Open
#453 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
42
Forks
160
Avg merge
3h 9m
Merged PRs (30d)
4

Description

I have a suggestion for https://craftcms.com/docs/4.x/testing/testing-craft/setup.html

Codeception.yml
Open the codeception.yml file and replace its content with the following:

You should specify where to put/edit the file. After a newly installed CraftCMS, this file is only in vendors. We're not going to update a file directly in vendors.

Edit : The documentation does not seem up to date. Using BD_DNS instead of CRAFT_DB_DRIVER, ... like on current fresh installs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The target is the linked Setting Up Tests page, especially its Codeception.yml instructions. First inspect where codeception.yml is placed in a newly installed Craft CMS and compare the documented CRAFT_DB_DRIVER setting with the current BD_DNS usage; done means the page names the correct file location and current configuration.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.