Skip to content
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

walk through git workflow for a project that requires certain branching strategy #12

Open
ConsenSys-Academy opened this issue Jun 3, 2021 · 3 comments
Labels
good first issue Good for newcomers intermediate issues that require mid-level engineering experience

Comments

@ConsenSys-Academy
Copy link
Collaborator

The Git section, Module 6, is a bit light in terms of walking through common git flows. It'd be great to use a real-world example to show forking a project, making changes, committing those changes, then issuing a PR. Also good to address what happens when you need to rebase your commits to make descriptions pass requirements by the repo or project.

@ConsenSys-Academy ConsenSys-Academy added good first issue Good for newcomers intermediate issues that require mid-level engineering experience labels Jun 3, 2021
@ConsenSys-Academy
Copy link
Collaborator Author

@ConsenSys-Academy
Copy link
Collaborator Author

@kvutien
Copy link
Contributor

kvutien commented Jun 18, 2021

I found this blog very useful, but IMHO, this mikkei stuff is rather of "intemediate" leveL The reason are that

  • it's about a workflow (so it's good for a beginner) but this workflow is written as a discussion among seasoned git users, not as a tutorial for beginners
  • the last section ("know your tools") is super-useful, but git rebase, git commit --amend, and git commit --fixup [hash] are not exactly the first things a beginner should learn

This makes me raise a potential threat for this training: loss of focus, or loss of structure. A beginner needs hand-holding. Ideally the reading material of this basic training should be numbered in recommended sequence of reading. Maybe I should make a distinct issue?

A typical counter-example of what not to do for beginners is the github repo of orbitdb. It's very organised and explained, but despite the "welcome" title, it's daunting. It's structured , but not for a beginner.

Hint: inside the repo field-manual there is a Tutorial and the repo web3-workshop has a sample React app. The latter has not up to date API calls and I'm trying to fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers intermediate issues that require mid-level engineering experience
Projects
None yet
Development

No branches or pull requests

1 participant