Codeinwp / Codeinwp/otter-blocks

Tester and Designer Handbook for Otter

Open
#1,936 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new feature
Dominant language
JavaScript
Stars
198
Forks
36
Avg merge
3d 4h
Merged PRs (30d)
30

Description

What problem does this address?

We should have some docs about best practices for testers and designers to report issues to developers and vice versa. Some small things can save a lot of time when done right.

Example for testing:

No helpful Helpful
image image
No clear indication about the error Clear indication about the error with console that also highlights the file where the problem is produced

Example for design:

No helpful Helpful
Your solution is good but is not consistent with others You have a problem with padding; check those [insert some references] to see the ratio.

⚠️ The biggest obstacle is that besides the developer, other people are not aware of different things. While in time, people involved in the project get the knowledge, which might reduce the inconsistency, sometimes new people might be involved or a person has not been in touch with the project and might not be aware of the changes.

What is your proposed solution?

Docs with clear examples about good communication with the developer and vice versa.

Will this feature require documentation? (Optional)

None

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 issue does not name a documentation path, file, or test to use. Start by locating the project's existing documentation structure and deciding where a tester and designer handbook belongs. Done means publishing clear, consistent examples for reporting issues and giving actionable feedback between testers, designers, and developers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.