microsoft / code-with-engineering-playbook

This is the playbook for "code-with" customer or partner engagements
https://microsoft.github.io/code-with-engineering-playbook/
Creative Commons Attribution 4.0 International
2.15k stars 568 forks source link

ADR IDs can be bound to work item ID #1028

Open benjguin opened 4 months ago

benjguin commented 4 months ago

Is your feature request related to a problem? Please describe.

When we have 3 or 4 people writing ADRs at the same time during an engagement, it's always frustrating to find the next ADR ID. They keep conflicting, and we have to rename the ADR file, change the decision log before submitting the PR about the new ADR.

Describe the solution you'd like

In the last couple of engagements, we found it simpler to use work item ID instead of a sequential ID for new ADRs.

Describe alternatives you've considered

We first started with the sequential number but it didn't work well.

A random number could also work but it's not as sequential nor as meaningful as the work item ID.

Additional context

N/A