otto-de
feat(guidelines): add new rule for sending durable event ids
I feel this is strongly related to idempotency. What do you think about linking the article? https://github.com/otto-de/api-guidelines/blob/15c925dedcb3d474b17d33fc35fc6015f5289c2c/dev-context/async/03-decisions/consumption-idempotency.md
The dev-context section is not linkable in our API portal. But feel free to link the corresponding guideline: https://api.otto.de/portal/guidelines/r200002
Like that rule, maybe we could also add a link to https://api.otto.de/portal/guidelines/event-guidelines/concepts#events as we already quote it.
Hi @JanKlasser3000 , thanks for this PR 🚀 From a technical writing perspective, I suggest the following:
For the Changelog (PR body):
New
- SHOULD send durable event IDs R000058
For the PR title (I know, we don't have a convention for that yet, but ...😉)
feat(guidelines): add new rule for sending durable event ids
Thanks for all the input and I will do the changes about the wording.
I agree about the correlation for the differenct sections, however I think it can also be confusing to add to many links and makes it a bit hard to get an overview. Could we also move the concept in the menu up, so its clear its valid for all the rules? For the idempotency a link can be useful, maybe the other way round, to indicate that event IDs can be used for idempotency checking?
As for the title, its the best I could come up with, however I am open for suggestions
Thanks for all the input and I will do the changes about the wording.
I agree about the correlation for the differenct sections, however I think it can also be confusing to add to many links and makes it a bit hard to get an overview. Could we also move the concept in the menu up, so its clear its valid for all the rules? For the idempotency a link can be useful, maybe the other way round, to indicate that event IDs can be used for idempotency checking?
As for the title, its the best I could come up with, however I am open for suggestions
Linking the other way around makes sense to me. For me, it's also okay to leave the link to the events section to not overwhelm the reader.
I changed the PR, ready for approval ( in case nothing new is requested )