diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9f99dcb6..201ab0bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,16 +2,16 @@ Changelog: ### New -- [New ruleID](URL) -- [New section](URL) +- Rule name [New ruleID](relative path) +- [Name of new section](relative path) ### Update -- Added paragraph to rule [](URL). -- Refactored rule [](URL). -- Relaxed criteria in rule [](URL). +- Added paragraph to rule "rule name [ruleID](relative path)". +- Refactored rule "rule name [ruleID](relative path)". +- Relaxed criteria in rule "rule name [ruleID](relative path)". -### Remove +### Removal -The rule [ruleName] has been removed, because... -(if applicable) It has been replaced by rule [](URL). +The rule "rule name" has been removed, because... +(if applicable) It has been replaced by rule "rule name [ruleID](relative path)". diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 227dfca8..f66df475 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,19 +48,19 @@ Changelog: ### New -- [New ruleID](URL) -- [New section](URL) +- Rule name [New ruleID](relative path) +- [Name of new section](relative path) + ### Update -- Added paragraph to rule [](URL). -- Refactored rule [](URL). -- Relaxed criteria in rule [](URL). +- Refactored rule "rule name [ruleID](relative path)". +- Relaxed criteria in rule "rule name [ruleID](relative path)". -### Remove +### Removal -The rule [ruleName] has been removed, because... -(if applicable) It has been replaced by rule [](URL). +The rule "rule name" has been removed, because... +(if applicable) It has been replaced by rule "rule name [ruleID](relative path)". ``` Pay attention to the following when editing this template: @@ -83,7 +83,9 @@ Changelog: ### Update +- Refactored rule "MUST provide meaningful `source` context attribute [R200010](../api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-context-attribute.md)". - Updated the information on contract for [async](https://api.otto.de/portal/guidelines/event-guidelines/contract) and [rest](https://api.otto.de/portal/guidelines/rest-guidelines/contract). + ``` ## Report a bug diff --git a/api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-contex-attribute.md b/api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-context-attribute.md similarity index 100% rename from api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-contex-attribute.md rename to api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-context-attribute.md diff --git a/api-guidelines/async/format/cloudevents/rules/must-use-cloudevents-format-to-encode-events.md b/api-guidelines/async/format/cloudevents/rules/must-use-cloudevents-format-to-encode-events.md index 04cbdbc6..40656c1a 100644 --- a/api-guidelines/async/format/cloudevents/rules/must-use-cloudevents-format-to-encode-events.md +++ b/api-guidelines/async/format/cloudevents/rules/must-use-cloudevents-format-to-encode-events.md @@ -13,7 +13,7 @@ The following table shows the most important context attributes of the CloudEven | Context attribute | Event Guidelines rules | | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | | [id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) | | -| [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) | [MUST provide meaningful source context attribute](./must-provide-meaningful-source-contex-attribute.md) | +| [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) | [MUST provide meaningful source context attribute](./must-provide-meaningful-source-context-attribute.md) | | [specversion](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) | only '1.0' allowed | | [type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) | [MUST follow naming scheme for type context attribute](./must-follow-naming-schema-for-type-context-attribute.md) | | [datacontenttype](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#datacontenttype) | [MUST provide datacontenttype context attribute if media type is defined](./must-provide-datacontenttype-context-attribute-if-media-type-is-defined.md) | diff --git a/changes/changelog.md b/changes/changelog.md index 28cd74ce..3fa9d930 100644 --- a/changes/changelog.md +++ b/changes/changelog.md @@ -5,7 +5,7 @@ ## 2023-06-23 -### Remove +### Removal The following rules have been removed as this is consumer-facing content and already available in the REST API sections "Getting started" and "About the API". @@ -96,7 +96,7 @@ The following rules have been removed as this is consumer-facing content and alr ### Update -- Generalized source prefix in rule "MUST provide meaningful `source` context attribute [R200010](../api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-contex-attribute.md)". +- Generalized source prefix in rule "MUST provide meaningful `source` context attribute [R200010](../api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-context-attribute.md)". ## 2022-08-31 @@ -154,7 +154,7 @@ The following rules have been removed as this is consumer-facing content and alr ### New -- MUST provide meaningful `source` context attribute [R200010](../api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-contex-attribute.md) +- MUST provide meaningful `source` context attribute [R200010](../api-guidelines/async/format/cloudevents/rules/must-provide-meaningful-source-context-attribute.md) ## 2022-03-31