Writing scenarios

The Scenarios panel on a story lists every scenario tagged with that story, from any feature file in the project. Open one to edit it, or add a new one.

The editor

• Highlighting for keywords, tags, tables, doc strings and comments.
• Problems in plain words, checked as you type, against the whole file the scenario lives in. Each one links to its line: for example Line 7: a Scenario Outline needs an Examples table below it. A problem elsewhere in the file says where it is.
• Format tables lines up the tables in the scenario you are editing. Nothing else in the file moves.
• Step suggestions come from the steps your project already uses, so the same step is written the same way.
• Manual: one checkbox adds or removes the manual tag on that scenario.
• The editor never traps the keyboard: Esc leaves it, and Tab moves focus on.

Saving

• A file Scenario Book can read is saved even with warnings. A file it cannot read at all is refused, with the reason, so an unreadable file never reaches your repository.
• If someone else saved the same file a moment ago, your save is refused and your text stays in the editor. Nothing is overwritten.
• Saving one scenario replaces only its lines. The rest of the file keeps its exact bytes, including spacing, comments and line endings.

Versions

Every save keeps a version, with where it came from: Jira, an import or your pipeline. Compare any version with the current one line by line, and restore it; restoring adds a new version rather than erasing history. Each file keeps its last 50 versions.

Names

Scenario Book shows you, a teammate, your pipeline or an import rather than people's names. It doesn't ask for permission to read user profiles, so it never stores a name or email address.