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

proposal: design decision notes #75

Closed
Tracked by #60
iuioiua opened this issue Apr 12, 2023 · 1 comment
Closed
Tracked by #60

proposal: design decision notes #75

iuioiua opened this issue Apr 12, 2023 · 1 comment
Labels
enhancement New feature or request v1

Comments

@iuioiua
Copy link
Contributor

iuioiua commented Apr 12, 2023 •
edited
Loading

It's essential that we, as maintainers and users, understand the reasons behind our design decisions. I'd like to include notes on these design decisions and architectural details in the codebase. We can do so via JSDoc comments within the code or in the README. I'm leaning towards JSDoc comments right now. Either way, aspects worth talking about include the following:

  • Blog
  • Database
  • Formatting
  • Fresh
  • Linting
  • Payments
  • Testing
@iuioiua iuioiua mentioned this issue Apr 12, 2023
Closed
30 tasks
@iuioiua iuioiua changed the title proposal: add JSDocs across the codebase addressing design decisions and reasoning proposal: design decision notes Apr 18, 2023
@iuioiua iuioiua mentioned this issue Apr 18, 2023
Merged
@iuioiua iuioiua added the enhancement New feature or request label May 3, 2023
@iuioiua iuioiua mentioned this issue May 8, 2023
Merged
@iuioiua iuioiua added the v1 label Jul 18, 2023
@iuioiua
Copy link
Contributor Author

iuioiua commented Aug 31, 2023

Closing in favour of #460.

@iuioiua iuioiua closed this as not planned Won't fix, can't repro, duplicate, stale Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request v1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@iuioiua