Skip to content

Add Learn Git Branching #3

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

anitacheung83
Copy link

No description provided.

Copy link
Collaborator

@lmg8 lmg8 left a comment

Choose a reason for hiding this comment

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

This resource provided on git branching looks like a valuable resource for anyone looking to learn how git branching works. I feel like this will be useful to lots of students in this class, especially for the upcoming D2. Good job!

I have just one small request before I approve, your last point mentions looking at their repo. Can you provide specifics of what students should look for? Or if you can provide a small summary of what's useful when looking at their repo?

Edit: I would also follow the structure of the README.md table of contents & update the README.md file with your new topic under Development Process.

@anitacheung83
Copy link
Author

On the Learn Git Branching repo, they briefly talked about how the website work including levels and sandbox mode. Furthermore, Learn Git Branching is an open source project, if students are interested that can contribute to it.

I will also update the README.md file with the new topic. Question: Should git branching be put as a subtopic of gitflow?

Add Git branching as a sub-branch on Git Flow under readme.md
Add reasons why I provided Learn Git Branching Github repo
@anitacheung83 anitacheung83 reopened this Mar 3, 2023
@anitacheung83
Copy link
Author

Add Git branching as a sub-branch on Git Flow under readme.md
Add reasons why I provided Learn Git Branching Github repo under development_process.md

Copy link
Collaborator

@lmg8 lmg8 left a comment

Choose a reason for hiding this comment

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

After David's comment on today's class, I think it would be beneficial to expand on the git branching topic with a paragraph or two. A suggestion would be to go over the concepts covered in the site.

@anitacheung83
Copy link
Author

Add git commands

@anitacheung83
Copy link
Author

According to A3,

  1. Contributors: You can sign up to contribute to one or two topics related to software engineering. These contributions can be a Pull Request for any of the following:
    a. Creating new entries, pages, links and address a new topic
    b. Editing existing entries
    c. Reorganizing to clarify, simplify, or break down topics

FAQ
1b. Do I have to write the contribution all myself?
No. You can link to an external source and write a few sentences summarizing how it helps a CSC301 student. As long as it’s clear that you’re not claiming to have done someone else’s work, you are fine.

Our contribution can be any of the following, including links, and it does not require an expansion on the topic. As expansion on the topic can be contributed by other students. In my pull request, I have explained why the link I provided can help CSC301 students, therefore, going over the concepts covered in the site will not be necessary.
Please feel free to let me know if my understanding for the assignment is incorrect.

Copy link
Collaborator

@lmg8 lmg8 left a comment

Choose a reason for hiding this comment

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

This looks good! It provides a concise summary of Git branching and includes examples of git commands with easy to follow explanations. I think this will be helpful for students who don't know how git branching works.

@elsa-huang elsa-huang mentioned this pull request Mar 9, 2023
Copy link
Contributor

@jorjani jorjani left a comment

Choose a reason for hiding this comment

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

Please organize content and resolve conflicts

Copy link
Collaborator

@lmg8 lmg8 left a comment

Choose a reason for hiding this comment

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

Sorry for the late response. It seems that a PR was merged that highlighted git branching workflow here: https://github.com/learning-software-engineering/learning-software-engineering.github.io/pull/22/files

I would go about expanding what's already there or contributing something different.

Also it seems that it should be under "Software Tools", but it looks like it's currently not in the website:
image

If you decide to add to what's already there, I would add the Software Tools section in index.md

@anitacheung83
Copy link
Author

According to the lecture and the assignment handout, the topic should be first come first serve. I am the earliest person in the whole class to signup, create pr and made changes right after a request is issued. Therefore, whoever that come after me should be responsible for contributing something different. Therefore, it would not be fair for me to change my topic.

I am willing to resolve repeated topic with people that sign up later than I am and even suggest other topics for them to contribute. However, I will not change my topic as the responsibility should not be on my end.

Copy link
Collaborator

@lmg8 lmg8 left a comment

Choose a reason for hiding this comment

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

I completely agree with it not being your responsibility to change your topic. Can you add a link to software tools page in the main table of contents and then create a separate page for Git, and link it inside software tools? Let me know if you need further clarification.

@anitacheung83 anitacheung83 reopened this Mar 23, 2023
AshkanAleshams added a commit that referenced this pull request Mar 18, 2024
…ral-intro-menubar-buttons

Explain menu bar buttons
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.

3 participants