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

Minor README Updates for Installation #1062

Merged
merged 16 commits into from
Nov 28, 2023
Merged

Minor README Updates for Installation #1062

merged 16 commits into from
Nov 28, 2023

Conversation

farisdurrani
Copy link
Member

@farisdurrani farisdurrani commented Nov 28, 2023

Minor README Updates for Installation

Github Issue Number Here: #1010
What user problem are we solving?
Early in the semester, some new members had difficulty installing and starting the backend and frontend. We make slight improvements to the README, especially in adding screenshots, to help with this process.

What solution does this PR provide?
Upgraded Node version, added screenshots, linked to Bug Manual page, fixed build issue

Testing Methodology

How did you test your changes and verify that existing functionality is not broken

While no testing is necessary since changes are to the README, starting the frontend showed no errors.

Any other considerations
Some items on the original Issue were not considered important enough to be added to the README, and hence they're put to the Bug Manual page, now linked

@farisdurrani farisdurrani self-assigned this Nov 28, 2023
@farisdurrani farisdurrani requested a review from a team as a code owner November 28, 2023 23:41
Copy link
Contributor

sweep-ai bot commented Nov 28, 2023

Apply Sweep Rules to your PR?

  • Apply: All new business logic should have corresponding unit tests.
  • Apply: Refactor large functions to be more modular.
  • Apply: Add docstrings to all functions and file headers.

@farisdurrani farisdurrani linked an issue Nov 28, 2023 that may be closed by this pull request
Copy link
Member

@karkir0003 karkir0003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left minor comments. looks good to me overall. thanks for this faris

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Nov 28, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@farisdurrani
Copy link
Member Author

Resolved comments @karkir0003. Thanks!

@karkir0003
Copy link
Member

approved @farisdurrani

@farisdurrani farisdurrani added this pull request to the merge queue Nov 28, 2023
Merged via the queue into nextjs with commit ae8f84d Nov 28, 2023
10 checks passed
@farisdurrani farisdurrani deleted the workflow-updates branch November 28, 2023 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE]: Improve README Instructions
2 participants