VivianWilde
commented
2 months ago Hi! Sorry for dropping the ball on this so horribly.
- We could potentially reorder so that project structure is at the top (since that's the most "high-level" aspect of the organisation"
- Preface the interface bit with a link to interfaces and how they work in react, such as this one
- For code style - if we're using the auto-formatter configured in package.json (via ~prettier~) we can just tell people to make sure to run ~npm format~ beforehand or automatically do that, and so people don't have to care about code style themselves.
We use an auto-formatter to handle styling. So simply run
npm run formatwithin the repo before committing, and it will ensure the code is formatted according to our requirements.
For the MUI style guidelines, I've added a draft of them as a new section to the document.
na933950
Issue Number
5 and #3
Does not close either issue.
Type of Change
This change adds documentation for best practices when writing React code. This also includes organization/project structure.
Details
Added sections on how to write accurate and modern code, then focused on organization for files to go in the correct place, and then wrote a section on best practices while creating React components in particular, which include expectations related to abstraction, documentation, and commenting.
Screenshots
N/A
How Has This Been Tested?
There is not much testing to do, but all links have been verified as working in the Table Of Contents.
Checklist
N/A
Remaining Work
@VivianWilde I don't have as much knowledge with the testing framework (especially I was running into that issue with setting up absolute imports which would be really nice) with
jestand also with styling via Material UI. I've always had trouble with best practices for styling so probably better I don't write that section.Create Styling Best Practices: #8 Create Testing Best Practices: #9