Maria: Workflows, 2 weeks

MMikhailova commented 2 years ago

Learning Objectives

Priorities: 🥚, 🐣, 🐥, 🐔 (click to learn more)

There is a lot to learn in this repository. If you can't master all the material at once, that's expected! Anything you don't master now will always be waiting for you to review when you need it. These 4 emoji's will help you prioritize your study time and to measure your progress: - 🥚: Understanding this material is required, it covers the base skills you'll need for this module and the next. You do not need to finish all of them but should feel comfortable that you could with enough time. - 🐣: You have started all of these exercises and feel you could complete them all if you just had more time. It may not be easy for you but with effort you can make it through. - 🐥: You have studied the examples and started some exercises if you had time. You should have a big-picture understanding of these concepts/skills, but may not be confident completing the exercises. - 🐔: These concepts or skills are not necessary but are related to this module. If you are finished with 🥚, 🐣 and 🐥 you can use the 🐔 exercises to push yourself without getting distracted from the module's main objectives. ---

🥚 0. Local Development Without Git

Practice the foundational workflows of software development by learning to write Markdown locally on your own computer using Visual Studio Code (VSCode), the Command Line Interface (CLI), and NPM scripts to automate your code's quality (formatting, linting and spell checking).

[x] 🥚 Folder Structures: You can explain how files and folders are stored in your computer and can find, open or create files in your computer without using the Command Line Interface.
🥚 Command Line Interface (CLI): In a Unix shell you can ...
- [x] open a new terminal window
- [x] navigate up and down directories using cd
- [x] list the contents of a directory using ls
- [x] view the contents of a file using cat
- [x] create new files using touch
- [x] create new folders using mkdir
[x] 🥚 Markdown: You can write a document in Markdown with no syntax mistakes that renders into a well-formatted document.
🥚 VSCode: You can complete these workflows in VScode, and can use keyboard shortcuts to complete them all:
- [x] Opening a repository in a new window
- [x] Opening the VSCode terminal
- [x] Adding a new file
- [x] Adding a new folder
- [x] Deleting a file
- [x] Deleting a folder
- [x] Previewing a Markdown File
- [x] Formatting a Markdown document
[x] 🥚 READMEs: You can write a README file that describes the project you are working on, why it's helpful, and how someone can use it.
🥚 NPM: You can use NPM commands to verify your code's quality, this includes ...
- [x] using npm install to install a project's dependencies
- [x] reading a package.json file to find which scripts are available for the project
- [x] use npm run <script> to execute an npm script
🥚 Formatting Code: You can use Prettier to make sure all the code in your project is well-formatted:
- [x] You can use the Prettier VSCode extension to format a document while you are writing it
- [x] You can use npm run format to format all of the documents in your project
- [x] You can use npm run format:check to make sure all files are well-formatted
🥚 Linting Code: You can ...
- [x] use npm run lint:md to check all Markdown files in your folder for linting mistakes
- [x] you can fix all linting mistakes reported by npm run lint:md
🥚 Spell Check: You can ...
- [x] use the Code Spell Checker VSCode extension to correct spelling mistakes in your Markdown documents while you are writing
- [x] use npm run spell-check to check the spelling in all the files of your project
- [x] update .cspell.json to add words that should be allowed in your project
🥚 File and Folder Naming Conventions: You can ...
- [ ] identify and follow the naming conventions for the project you are working on.
- [ ] use npm run lint:ls to check that all files and folders follow the project's naming conventions.
- [ ] you can correct any file and folder names to make them match the project conventions.
[ ] 🐣 File Extensions: You can identify all of the languages covered at HYF and give the correct file extension. You don't need to know the languages, just recognize them.
[ ] 🐣 Touch Typing: You can write a Markdown file without looking at your keyboard to find any letters, numbers or special characters. (slowly is ok!)

🥚 1. Local Development With Git

Practice using Git to save and organize your development process. You will learn how you can use Git to go back to previous versions of your project, and to work on different changes in parallel.

🥚 Git: Using the CLI you can ...
- [x] Initialize a new git repository with git init
- [x] stage changes using git add <path>
- [x] commit changes using git commit -m <message>
- [x] display your repository's git history using git log
- [x] create a new branch using git branch <branch-name>
- [x] check out a branch using git checkout <branch-name>
- [x] create a new branch and check it out using git checkout -b <branch-name>
- [x] merge changes from one branch to another using git merge <branch-name>
- [ ] return to a previous version of your project with git log and git checkout <commit-hash>
- [ ] stash and retrieve uncommitted changes with git stash and git pop
🥚 .gitignore: You can use a .gitignore file to describe which files you don't want included in your git history.
🥚 VSCode: You can ...
- [ ] use the Git Graph extension to to visualize your repo's commit history
- [ ] use the Git Lens extension to investigate your repository's commit history
- [ ] explain how the file tree in VSCode can show you which files have uncommitted changes
[ ] 🥚 Atomic Commits: You can save your development progress using small commits with clear and helpful message.
[x] 🐣 Feature Branches: You can organize your development process using branches. You can create a new branch for each part of your project and merge those changes to main when they are finished.
🥚 1. Local/Remote Development

Learn how you can connect your local Git repositories with a GitHub repository to add more structure to your development process and to share your projects.

🥚 Licenses: You can ...
- [ ] explain why it's important to include a license for your code on GitHub
- [ ] choose a license for your projects that matches how you want others to use your code
[x] 🥚 GitHub SSH Key: You can connect your computer to your GitHub account using an SSH key, clone using the SSH link, and push/pull using your SSH connection.
🥚 GitHub Repositories: You can ...
- [x] create new repository on GitHub
- [x] write a description for your repository
- [ ] turn on GitHub Pages
- [ ] configure your repository to block pushing to main
- [ ] configure your repository to block merging to main until Continuous Integration (CI) checks have passed
🥚 Git Remote/Local Connection: You can ...
- [x] clone a remote repository to your computer
- [x] initialize a new repository locally and connect it to an empty remote repository
- [x] push and pull changes between remote & local branches
[x] 🥚 Pull Requests: You can create a pull request between two branches in your repository and merge changes without causing any conflicts.
[x] 🥚 PR templates: You can use a PR template to add a checklist to all of your PRs so you are sure the code is great before merging to main.
[x] 🥚 Continuous Integration: You can use GitHub Actions to check your code's quality before merging a pull request to the main branch.
[x] 🐣 Local/Remote Branching Workflow: You can use a branching workflow that keeps mistakes away from the main branch and prevents conflicts from happening in GitHub. For each contribution to the project you can ...
1. Check out a new local branch and write your code
2. Check out main on your local machine
3. Pull changes from remote main to local main
4. Merge changes locally from main to your new branch
  - Fix any conflicts on your new branch before pushing!
5. Format and lint your code
6. Push your new local branch to your remote repository
7. Open a Pull Request from the new branch to main
  - Go through the PR's checklist to make sure everything is correct
  - Make sure all CI checks pass!
8. Merge your new remote branch to main
  - You can delete the branch after it's merged if you want to

🐣 3. Remote Collaboration

Learn how to collaborate with a group on a single project hosted in a GitHub repository. Practice using GitHub's project management features to organize your group's tasks and to double-check your project's code quality.

[x] 🥚 Contributor Guidelines: Your group can define contributor guidelines that describes how everyone can add their work to the project.
[ ] 🥚 Code of Conduct: Your group can write a code of conduct for your project that describes how everyone should communicate and what behavior is considered unproductive.
[x] 🥚 Repository Contributors: You can add group members as collaborators in a repository.
[x] 🥚 Issue Templates: Your group can use issue templates to make sure all issues are complete and relevant to the project. in your repository and merge changes without causing any conflicts.
[x] 🥚 Code Review: You can use the PR Template and CI checks to review another group member's code before merging it to main.
🐣 GitHub Project Management: You can ...
- [x] use issues to define tasks in a group project. Each issue should have a helpful title, complete description, and helpful labels.
- [x] use a Project Board to organize a project's issues
- [x] claim issues and track your progress with the project board
- [ ] link a PR to your claimed issue
- [x] assign someone to review your PR
- [x] use GitHub code review features to discuss your code with your reviewer
[x] 🐣 Fixing Merge Conflicts: You can fix merge conflicts by selecting which change to keep, or deciding how to combine them. If a conflict occurs in a GitHub PR you can pull both branches and fixh the conflict locally.

🐥 4. Open Source Development

Explore the wider world of Open Source software by learning how communities of independent developers write and maintain the code we all rely on.

[ ] 🥚 Finding Issues: You can read through an open source project's issues and determine if there is one you can help with.
[ ] 🐣 Commenting in Issues: You can productively join the conversation in an open source projects' issues.
[ ] 🐥 Opening Issues: You can open a helpful issue in an open source repository, following their contributor guidelines and code of conduct.
[ ] 🐔 Contributing: You can create a fork of an open source project and open a PR that contributes something helpful and follows the Contributor Guidelines and Code of Conduct.

MMikhailova commented 2 years ago

Week 1

I Need Help With:

Reading a package.json file
Fixing all linting mistakes reported by npm run lint:md.
Should I fix them manually in my local repo:question:
Return to a previous version of your project with git log and git checkout
Is it something like "Undo"❓
Fixing conflicts when merging. I would like to go deeper in this topic, if possible.

What went well?

I've completed the Students bio deliverable surprisingly quickly and I really enjoyed writting markdown trying new things.
I've learned to write Markdown locally using VS Code, Terminal and NPM scripts
I am getting used to use keyboard shortcuts in VS Code
I am able to connect my local Git repositories with a GitHub repository:
- clone a remote repository to my computer
- push and pull changes between remote & local branches
I created a PR between my branch and main branch in my repo and merge changes
I dealt with emerged conflicts
I asked coaches for help and got answers
I was happy to help some of my classmates

What went less well?

-I understand NPM very theoretically

Sunday Prep Work

I am still in process of preparation to Sunday

danielhalasz commented 2 years ago

@MMikhailova you have done so much and nice to see that you have figured out a lot on your own and that you can help other classmates!

for now, it is enough to be able to read the scripts section of a package.json file to see what scripts are already configured for a specific project that you can run locally.
yes, you should fix all errors & warnings locally, to make sure that the tests pass on GitHub
indeed, git log and git checkout an older commit allows you yo return to a previous state of the git repo.
we will have all kinds of merge conflicts coming up when you start to work together next week 🙂

MMikhailova commented 2 years ago

Thank you @danielhalasz!

MMikhailova commented 2 years ago

Week 2

I Need Help With:

Understanding of the content of a package.json file
In case of a conflict should I change my code or package.json file code to solve the problem?

What went well?

I've learnt how to collaborate with my group on our common project hosted in a GitHub repository
I practiced using GitHub's project management features to organize my group's tasks and to double-check quality of our codes
I fixed several merge conflicts
I used our Project Board to organize a project's issues
What went less well?
Configuration of Yaml file used by Github

Sunday Prep Work

I am still in process of preparation to Sunday

danielhalasz commented 2 years ago

@MMikhailova being able to solve merge conflicts is a great skill to have! glad to hear that you have practiced it, there will be plenty more to come 🙂 you do not need to know more about package.json for now other than to check the scripts that are already existing for some repos. sometimes you might see that a dependency was updated, in that case you can keep the newer version when solving the merge conflict. Yaml and json files are both used to store data in a slightly different way, so you can read about their benefits and drawbacks here, but this is optional, you do not need to know this now: https://www.imaginarycloud.com/blog/yaml-vs-json-what-is-the-difference/

MMikhailova commented 2 years ago

@danielhalasz Thank you! Even if I don't need some info right now I really appreciate when you and other coaches find a time to explain what this info is about. It makes the bunch of unanswered questions in our heads a little less:smiley:

MMikhailova commented 2 years ago

Me

What was not clear, where did you get stuck?

I don't really have much difficulties related to assignments and learning materials.
However, sometimes I get stuck with general understanding of WHAT we are doing and WHY we are doing this.
For example, why should we use npm, solve conflicts, what are dependencies and etc.
After a while I understood the meaning of course, but at first I was stuck with HOW we can do it more than WHY.

What was clear, what did you master?

I love how the course is organised. Many thanks to the coaches for their contribution:clap:
I have mastered Git, Visual Studio Code (VSCode), the Command Line Interface (CLI) and NPM scripts to automate my code's quality (formatting, linting and spell checking).
I am now able to do local/remote development.
I've managed the group project by using GitHub Project management features.

Where can you still use some help?

General understanding of how to apply my new knowledge.

Where can you help others moving forwards?

I learn new things relatively fast, so I always try to help those who are stuck at some point.

The Course

What can there be more of?

Examples of realised projects that would motivate us move forward faster.
Explanation of general terms (dependencies, git, etc..)

What can there be less of?

Explanation of small and easy to find things that everyone can google on their own.

What material were most helpful (from HYF or elsewhere)?

Coach explanations
HYF Suggested study materials are great
freeCodeCamp.org

What HYF material was least helpful?

Some materials are stored in HYF repo and some in lab-brussels-1 which can sometimes be confusing.
Not a big deal though:smile:

Any suggestions for future classes?

Please keep doing what you do, it's great!:sparkles:

colevandersWands commented 2 years ago

Some materials are stored in HYF repo and some in lab-brussels-1 which can sometimes be confusing.

The idea behind this was to have general info that you'll need for the whole course in the class repo, information about how to succeed at HYF. The module repositories contain the specific information you're expected to learn in that module.

If this isn't a helpful way to split the info, or if you have a better idea, let us know!

danielhalasz commented 2 years ago

@MMikhailova indeed, you are right, this can be a bit confusing at the start, however, as there are changes made to the core modules, if they are managed in one place (rather then in every different class repo) it is more consistent and easier to update.

as for past class final projects, you can check some of them here:

https://github.com/HYF-Connect/hyf-connect https://github.com/BeHelp/BeHelp https://github.com/Hand-And-Paw/hand-and-paw https://github.com/IrinaSing/Readeer https://github.com/hyf-Group2-fp/Just4Giving

MMikhailova commented 2 years ago

Hello @danielhalasz and @colevandersWands!

Thank you for dedicating time to respond and explain everything.

I totally understood the organization logic of HYF modules and I am used to navigating.

The examples of past projects are also very helpful🙏

Hope to do my best in learning at HYF☺️

lab-brussels-1 / home