Skip to content

Commit

Permalink
Merge pull request #1 from Ketryx/anton/readme-improvements
Browse files Browse the repository at this point in the history
Fix typo, add language for code blocks
  • Loading branch information
dzenam authored Jun 17, 2024
2 parents b1a6aff + 7471600 commit 1be2a57
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ These glob patterns define the locations of configuration items within a Git rep
In the following example:

```
src/requrements/**/*.md
src/requirements/**/*.md
features/**/*.feature
!src/**/README.md
```
Expand Down Expand Up @@ -49,7 +49,7 @@ Each markdown file is considered to be a single configuration item.

**Metadata** is defined in the front matter of a Markdown file:

```
```yaml
---
itemId: some-unique-string-1234
itemType: Software Item Spec
Expand All @@ -67,7 +67,7 @@ itemImplements: KP-43, KP-44

Every Scenario in a Cucumber file is considered to be a configuration item.

```
```gherkin
Feature: Git-based Items
Background:
Expand Down Expand Up @@ -135,7 +135,7 @@ In Cucumber files, the configuration item type is always `Test Case`.

## Traceability to other configuration items

Traceability to other configuration items is used to define the relationship between configuration items. Depending on the configuration item type, different fields are used for this purpose.
Traceability to other configuration items is used to define the relationship between configuration items. Depending on the configuration item type, different fields are used for this purpose.

Here is the list of all possible fields that can be used in **Markdown** files:

Expand Down Expand Up @@ -166,7 +166,7 @@ In **Cucumber** files, every tag that starts with `@tests:` is considered to be

In a **Markdown** file, it is possible to define traceability between Git-based and Jira-based configuration items. For example, it is possible to define that a Software Item Spec, whose content is managed in a Git repository, fulfills a Requirement that is managed in Jira. In order to do this, define the `itemFulfills` field in the metadata of the Software Item Spec. The value of the `itemFulfills` field must be the Jira issue key.

```
```yaml
---
itemFulfills: KP-42
itemHasParent: KP-40
Expand All @@ -179,7 +179,7 @@ For **Cucumber** files, its enough to use the Jira issue key as a tag, e.g. `@te

In a **Markdown** file, it is possible to define traceability between Git-based configuration items. For example, it is possible to define that a Software Item Spec, whose content is managed in a Git repository, fulfills a Requirement that is also managed in the same Git repository. In order to do this, define the `itemFulfills` field in the metadata of the Software Item Spec. The value of the `itemFulfills` field must be the `itemId` of the Requirement.

```
```yaml
---
itemFulfills: some-unique-string-1234
itemHasParent: some-unique-string-1235
Expand All @@ -194,4 +194,4 @@ All configuration items that are managed in a Git repository and synced with Ket

## Versioning

Every Git-based configuration item is associated with a version of the Git repository. The version is determined by the release ref pattern or a branch that is defined during the project creation or editing process. For example, if the release ref pattern is set to `refs/tags/v#`, the version of the Git-based configuration item will be determined by the tag name. If the tag name is `v1.0.0`, the version of the Git-based configuration item will be `1.0.0`.
Every Git-based configuration item is associated with a version of the Git repository. The version is determined by the release ref pattern or a branch that is defined during the project creation or editing process. For example, if the release ref pattern is set to `refs/tags/v#`, the version of the Git-based configuration item will be determined by the tag name. If the tag name is `v1.0.0`, the version of the Git-based configuration item will be `1.0.0`.

0 comments on commit 1be2a57

Please sign in to comment.