Ibrahim Ali : Workflows : 2 Weeks
Opened this issue Β· 4 comments
β β Workflows : Week 1 β β
π πWhat went well π π
β Local Development Without Git β
-
π In a Unix shell i can ... π
-
open a new terminal window
-
navigate up and down directories using
cd
-
list the contents of a directory using
ls
-
view the contents of a file using
cat
-
create new files using
touch
-
create new folders using
mkdir
-
π VSCode: i can ... π
-
Opening a repository in a new window
-
Opening the VSCode terminal
-
Adding a new file
-
Adding a new folder
-
Deleting a file
-
Deleting a folder
-
Previewing a Markdown File
-
Formatting a Markdown document
-
i can write a README file that describes the project
-
i can use NPM commands to verify my code's quality, this includes ...
-
using
npm install
to install a project's dependencies -
reading a
package.json
file to find which scripts are available for
the project -
use
npm run <script>
to execute an npm script -
π Formatting Code: i can ... π
-
use
npm run format
to format all of the documents in my project -
use
npm run format:check
to make sure all files arewell-formatted
-
-
π Linting Folder and File Names: i can ... π
-
use
npm run lint:ls
to check all folder and file names in my project -
fix all linting mistakes reported by
npm run lint:ls
-
π Linting Code: i can ... π
- use
npm run lint:md
to check all Markdown files in my folder for
linting mistakes - fix all linting mistakes reported by
npm run lint:md
- use
-
π Spell Check: i can ... π
-
use the Code Spell Checker VSCode extension to correct spelling mistakes
in my Markdown -
use
npm run spell-check
to check the spelling in all the files of my
project -
update
.cspell.json
to add words that should be allowed in my
project -
π File and Folder Naming Conventions: i can ... π
- identify and follow the naming conventions for the project
- use
npm run lint:ls
to check that all files and folders follow the
project's naming conventions. - correct any file and folder names to make them match the project
conventions.
-
File Extensions: i can identify all of the languages covered at
HYF and give the correct file extension.
β Local & Remote Development With Git β
-
Initialize a new git repository with
git init
-
stage changes using
git add <path>
-
check what is staged with
git status
-
commit changes using
git commit -m <message>
-
display my repository's git history using
git log
-
create a new branch using
git branch <branch-name>
-
check out a branch using
git checkout <branch-name>
-
create a new branch and check it out using
git checkout -b <branch-name>
-
return to a previous version of my project with
git log
and
git checkout <commit-hash>
-
π Licenses: i can ... π
-
explain why it's important to include a license for my code on GitHub
-
choose a license for my projects
-
i can connect my account using an SSH key,
-
π in GitHub Repositories: i can ... π
- create new repository on GitHub
- write a description for my repository
- turn on GitHub Pages
- configure my repository to block pushing to
main
- configure my repository to block merging to
main
until Continuous
Integration (CI) checks have passed
-
π Git Remote/Local Connection: i can ... π
- clone a remote repository to my computer
- initialize a new repository locally and connect it to an empty remote
repository -
push
andpull
changes between remote & local branches
-
Pull Requests: i can create a pull request between two branches
in my repository and merge changes without causing any conflicts.
β β Workflows : Week 2 β β
β Remote Collaboration β
- i can add group members as collaborators in a repository.
- π Code Review: i can π
- use the PR Template and CI checks to review
another group member's code before merging it tomain
. - π GitHub Project Management: i can ... π
- use issues to define tasks in a group project.
- use a Project Board to organize a project's issues
- claim issues and track my progress with the project board
- link a PR to my claimed issue
- assign someone to review my PR
- use GitHub code review features to discuss my code with my reviewer
What went less well?
-
π Markdown: i cant write a document in Markdown with no syntax
mistakes that renders into a well-formatted document. -
π understand stash and retrieve git stash and git pop
β Agile Development β
Hi @Ibrahim86Ali
You still have to add the details of week 2
Hi @Ibrahim86Ali
You still have to add the details of week 2
i will update it thanks for reviewing
Markdown: i cant write a document in Markdown with no syntax
mistakes
Practice makes perfect. You can check some online examples.
understand stash and retrieve git stash and git pop
There are online tutorials and you will learn more in the coming weeks and modules
Markdown: i cant write a document in Markdown with no syntax
mistakesPractice makes perfect. You can check some online examples.
understand stash and retrieve git stash and git pop
There are online tutorials and you will learn more in the coming weeks and modules
i will try to do more Practice.... thanks @talmurshidi