Skip to content

Commit

Permalink
added UserGuide.md and filled in endorse story overview and automated…
Browse files Browse the repository at this point in the history
… tests description (#40)
  • Loading branch information
evelynnchen-cmu authored Oct 11, 2024
1 parent 33a5bea commit e72e91f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions UserGuide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
### 1. Feature Overview:

Feature Name: Endorse Post
Purpose: This feature enables TAs and professors to endorse posts, notifying all viewers that the content has been approved or supported by a professor or TA. It offers students a clear and reliable indicator of posts containing verified, legitimate information that they should prioritize reading.
Coder: Evelynn Chen, Vicky Chen, and Alice Le

### 2. Steps to test feature
Step 1: Sign into an authorized account (Professor or TA account)
Step 2: Enter and click into a published post
Step 3: Click on the Endorse button


### 3. Expected Result:
The endorse button on the post will no longer be available until someone unendorses the post by clicking on unendorse
(TA or Professor only)
Some sort of visual tag will appear on the post showing a TA or Professor has endorsed this post

### Automated Tests

### 1. Test Location
**Location**: test/posts.js, lines [135-165](https://github.com/CMU-313/nodebb-f24-boba/blob/f24/test/posts.js#L135-L165)

### 2. What is Being Tested
- **Tested Features**: The API for toggling the endorsed field for a Post.
- **Test Type**: Unit tests / back-end tests.

### 3. Coverage Justification
- **Coverage Justification**:
The tests cover all use cases of toggling the boolean field endorsed. By default, a post is not endorsed, and only one request to endorse/unendorse at a time should be processed.

0 comments on commit e72e91f

Please sign in to comment.