docs: update README #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jossmurphy
approved these changes
Sep 18, 2021
hanlinc27
requested changes
Sep 18, 2021
README.md
Outdated
| git tag <semver> <short-hash-of-main-commit> | ||
| git push origin --tags | ||
| ``` | ||
| The backend runs at http://localhost:5000 and the frontend runs at http://localhost:3000. |
There was a problem hiding this comment.
nit:
Suggested change
| The backend runs at http://localhost:5000 and the frontend runs at http://localhost:3000. | |
| The backend runs at `http://localhost:5000` and the frontend runs at `http://localhost:3000`. |
README.md
Outdated
| @@ -194,6 +126,7 @@ git push -f | |||
|
|
|||
| ### Commits | |||
| * Commits should be atomic (guideline: the commit is self-contained; a reviewer could make sense of it even if they viewed the commit diff in isolation) | |||
| * Please follow the commitlint guidelines | |||
There was a problem hiding this comment.
Suggested change
| * Please follow the commitlint guidelines | |
| * Please follow the [commitlint](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for writing descriptive commits |
hanlinc27
reviewed
Sep 18, 2021
|
|
||
| Starter Code is an easy to set up, flexible, and customizable bootstrap that aims to encourage best development practices and provide baseline implementations of features common to UW Blueprint projects. 24 different stack combinations are supported, allowing "mix and match" between our most commonly used technologies. For more information on the motivation and design decisions behind Starter Code, please check out the home page of our [documentation site](https://uwblueprint.github.io/starter-code-v2)! | ||
|
|
||
| Teams should adopt Starter Code and use it as a foundation to get their projects off the ground faster, and as a guideline for how to structure their applications. We hope Starter Code will help project teams output higher quality and maintainable code, and allow them to focus on building cool, interesting features instead of setting up and doing boilerplate work. Put simply, Starter Code is here to help us deliver more value to our NPO partners. | ||
|
|
There was a problem hiding this comment.
Add Web platform for [Community Fridge KW Donor](https://www.instagram.com/communityfridgekw/?hl=en) Scheduling!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Notion ticket link
Update Readme
Implementation description
Checklist