Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): update contributing and pr template #46

Merged
merged 6 commits into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [<ruleID>](URL).
- Refactored rule [<ruleID>](URL).
- Relaxed criteria in rule [<ruleID>](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 [<ruleID>](URL).
The rule "rule name" has been removed, because...
(if applicable) It has been replaced by rule "rule name [ruleID](relative path)".
18 changes: 10 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [<ruleID>](URL).
- Refactored rule [<ruleID>](URL).
- Relaxed criteria in rule [<ruleID>](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 [<ruleID>](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:
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down
6 changes: 3 additions & 3 deletions changes/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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".

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down