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.

Sign up for GitHub

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

Jump to bottom

Added design doc template #2029

Merged
merged 6 commits into from
Apr 17, 2024
Merged

Added design doc template #2029

merged 6 commits into from
Apr 17, 2024

Conversation

MaksymilianDemitraszek
Copy link
Member

@MaksymilianDemitraszek MaksymilianDemitraszek commented Apr 16, 2024 •
edited
Loading

Goal is to keep it high level and reduce the friction of writing design docs.

Let me know if you thing we should include something here / remove something.

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Performed self-review of the code
  • Added changes to CHANGELOG.md

Arcticae
Arcticae approved these changes Apr 16, 2024
View reviewed changes
Copy link
Contributor

@Arcticae Arcticae left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have a numbering convention as well? I think it'd make more sense to refer to this later on as "DD-01/02/03..." or something

@MaksymilianDemitraszek
Copy link
Member Author

I think titles are better for searching purposes than numbers

@MaksymilianDemitraszek MaksymilianDemitraszek added this pull request to the merge queue Apr 17, 2024
Merged via the queue into master with commit bdcad01 Apr 17, 2024
13 checks passed
@MaksymilianDemitraszek MaksymilianDemitraszek deleted the design-docs-cleanup branch April 17, 2024 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkaput mkaput mkaput approved these changes

@Arcticae Arcticae Arcticae approved these changes

@piotmag769 piotmag769 piotmag769 approved these changes

@THenry14 THenry14 Awaiting requested review from THenry14

@ddoktorski ddoktorski Awaiting requested review from ddoktorski ddoktorski is a code owner

@drknzz drknzz Awaiting requested review from drknzz

@Draggu Draggu Awaiting requested review from Draggu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@MaksymilianDemitraszek @mkaput @Arcticae @piotmag769