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

docs(contribution-guidelines): add API design best practices #90

Open
HasithDeAlwis opened this issue Sep 4, 2024 · 1 comment
Open
Labels
backend Backend related

Comments

@HasithDeAlwis
Copy link
Collaborator

Problem Statement

API development can get messy and unorganized as production services increase in size. Minimizing confusion and enforcing design principals (ie. dependency injection, testing, etc.) will go a long way to maintaining a monorepo API. The goal of documenting best practices for API design is to provide distinct steps any contributor can take to write a new endpoint that we can ensure is bulletproof and bug free (as much as we can)

Goals

  1. Enforce naming conventions
  2. Testing conventions
  3. Implement DRY conventions
  4. File structure documented

Notes

Best practices are determined overtime. As we start learning best practices the doc site will be updated. For now, contributors will write down best practice findings in the comments of this PR. Once we've had a group discussion among the core dev team, we'll start the documentation process on our docs site.

@JeremyFriesenGitHub JeremyFriesenGitHub changed the title docs(contributing-guideliens): document best practices for API design docs(contributing-guidelines): document best practices for API design Sep 5, 2024
@JeremyFriesenGitHub
Copy link
Contributor

any updates on this issue @HasithDeAlwis? are we good to close it?

@MFarabi619 MFarabi619 changed the title docs(contributing-guidelines): document best practices for API design docs(contributing-guidelines): add API design best practices Oct 19, 2024
@MFarabi619 MFarabi619 changed the title docs(contributing-guidelines): add API design best practices docs(contribution-guidelines): add API design best practices Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Backend related
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants