Changes
Page history
Update Tim's Journal
authored
Sep 22, 2021
by
Timothy Catana
Show whitespace changes
Inline
Side-by-side
Tim's-Journal.md
View page @
5682e120
...
...
@@ -356,3 +356,70 @@ Master A-<name> B-<name> C-<name> D-<name>
- Updated wiki to add this.
4:07 PM - Finished Work
# Sept 22, 2021
9:44 AM - Started Work
- Did some reading on react coding conventions
- Finished refactoring the epic &3 branch
## Bugs
### Project Configured Even After Added To Database
- The code configures a project that has already been added to the database
- This is an easy fix, I think the code is analyzing the wrong database when seeing if it wa already configured
## Created Issues
### 252
- Create tests for epic &3
- Will be done next
### 253
- Instructors and Students have identical components
- Might as well have a `
shared components
` for these identical components
- Instead of harcoded functions/labels, we can toss them in as props
- This will cut down on the number of `
.js
` files we have
### 254
- We should seperate the components in the `
components
` folder further
- Create folders for components which are working on the same "large" task
- Cause the components folder is getting complicated
- Tests for each component can go into the seperate folders and make the project cleaner
### 255
- Comments at the top of the components should be added
- Comments should be <b>brief</b> and <b>to the point</b>
- Comments should tell the reader what the component is and what it does
- Component names should still be self explanatory
### 256
- Get rid of comments that tell whay code does
- The code should be written in a way that it should be self explanatory
- If the functionality of a variable of method is ambiguous, change the variable/method name
### 257
- Load the newly created stdent database into the students `
StudentPage.js
`
## Issue Naming Convention
- Issues should be in this format:
```
&<EpicId> - <title>
```
- `
&
` is required
- `
<EpicId>
` is the epic id of the epic that the issue has been created for.
- If the issue is not created for a specific epic, then `
<EpicId>
` should be `
0
`
- `
-
` is required
- `
<title>
`
the title of the issue.
-
Can be anything
-
Try to be brief and descriptive
\ No newline at end of file