-
-
Notifications
You must be signed in to change notification settings - Fork 432
Update Wireframe and Form-Control README.md #1212
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
base: main
Are you sure you want to change the base?
Changes from all commits
295dfec
8902666
3031ef0
97cf4b7
987fc35
a5c9a6b
1703f01
9a0f62b
48f0e43
c09a79a
5107b9c
56346f6
998d790
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| ## Clean Code and Smart Commits: A Practical Guide | ||
|
|
||
| ### 1. Formatting code consistently | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we want to add any requirements about formatting to the problem requirements? Or just leave this as a suggestion?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I now added a "Adhere to Professional Standards" category in the Acceptance Criteria, and included these checklist items:
|
||
|
|
||
| - In VS Code, right-click anywhere in the editor and choose "Format Document" from the context menu. | ||
|
|
||
| - You can also use the shortcut: | ||
| - Windows/Linux: `Shift + Alt + F` | ||
| - macOS: `Shift + Option + F` | ||
|
|
||
| - More details: https://code.visualstudio.com/docs/editing/codebasics#_formatting | ||
|
|
||
| --- | ||
| ### 2. Enabling automatic formatting | ||
|
|
||
| - Open your VS Code settings (user or workspace settings). | ||
| - Guide: https://code.visualstudio.com/docs/getstarted/settings#_creating-user-and-workspace-settings | ||
| - Search for `editor format` | ||
| - Set `editor.formatOnSave` and `editor.formatOnPaste` to true | ||
|
|
||
| This ensures your code stays clean without needing manual formatting each time. | ||
|
|
||
| --- | ||
|
|
||
| ### 3. Committing files often, in meaningful groups | ||
|
|
||
| Creating small, focused commits improves both your workflow and team collaboration. | ||
|
|
||
| Why this matters: | ||
| - **Clarity**: Each commit tells a clear story (one feature, one fix, one change). | ||
| - **Debugging**: Easy to find and undo the commit that caused a bug. | ||
| - **Collaboration**: Teammates can review and understand changes faster. | ||
| - **History**: Project log becomes a readable timeline, not a messy dump. | ||
| - **Safety**: Progress is saved in safe, logical steps—less risk of losing work. | ||
|
|
||
| #### Appraoch 1: Using VS Code | ||
|
|
||
| - In the Source Control panel, stage individual files instead of all changes. | ||
| - Commit only what is staged. | ||
| - Watch this video (around 12:50): https://www.youtube.com/watch?v=z5jZ9lrSpqk&t=705 | ||
|
|
||
| #### Approach 2: Using Git commands | ||
|
|
||
| 1. Stage a changed file (`git add`) | ||
|
|
||
| e.g.: To stage a modified file named `index.html` | ||
| ``` | ||
| git add index.html | ||
| ``` | ||
|
|
||
| 2. Commit the staged changes: (`git commit`) | ||
|
|
||
| e.g.: To commit the staged changes with a short commit message | ||
| ``` | ||
| git commit -m "Fix syntax error" | ||
| ``` | ||
|
|
||
| - Additional resource: [W3School Git Tutorial](https://www.w3schools.com/git/default.asp?remote=github) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does anything actually point people at this file? I suspect they are unlikely to happen upon it by chance...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the link to this guide in the "Resources" section in the
README.mdfile of each exercise.