feat: updates styleguide markdown

[seanmnguyen]

Closes #76

Overview

Updates the STYLE_GUIDE.md to include industry standards and best practices regarding TypeScript naming conventions, commenting, and importing.

Testing

None

Screenshots / Screencasts

None

Checklist

• Code is neat, readable, and works
• Code is commented where appropriate and well-documented
• Commit messages follow our guidelines
• Issue number is linked
• Branch is linked
• Reviewers are assigned (one of your tech leads)

Tip: You can make the issue and then check them after the fact or replace [ ] with [x] to check it!

Notes

Adopted styles from the following resources:

• https://gist.github.com/anichitiandreea/e1d466022d772ea22db56399a7af576b
• https://docs.aws.amazon.com/prescriptive-guidance/latest/best-practices-cdk-typescript-iac/typescript-best-practices.html
• https://www.browserstack.com/guide/coding-standards-best-practices

[soramicha]

Can you add more details on what a PR should include? Basically reiterating the PR template that's shown whenever we make a PR, and what additional things or examples we can write in it.

[soramicha]

Here are some other parts that would be great if you can add:

• standard patterns of writing tests (basically I want all of our way of writing tests to be consistent)
• standard patterns of writing certain code (such as filtering/sorting - right now, we are all writing them in our own way and it would be difficult to use them if they are all each uniquely structured) for now, mainly writing rules for this is the goal - in the future, we would need to add more when it comes to creating components and such but it's not necessary at the moment.

like for filtering, i think this way looks good: #69

and so on Postman, we would call like this:

And so it would be ideal to have filter AND sorting to be structured something like this:

query {
volunteers(
filter: {
statuses: ["PROFESSIONAL", "STUDENT"],
roles: ["Developer"],
chapters: ["Cal high"]
}
sort: {
firstName: ascending
}
) {
volunteer_id
first_name
}
}

something like that so variables "sort" and "filter" are the same and not renamed to something like "sortingOrder", etc.

[soramicha]

can you add a file naming convention as well?

[soramicha]

and specify for which types of files we would name in what certain way

[soramicha]

can you also add a section of code organization? so in a file, in what order would we put our code? for example, imports are up first obviously, then we would add what? if we had variables, etc. would we put them at the very top first before the rest of our code, etc.

this is to ensure that whenever we access files, we can quickly scan for places we want to know if our code organization is consistent, which would save us time

[soramicha]

Can you also mention in the style guide to add TODO comments if there is a part that's still needs to be done?