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

Rewrite2 #27

Merged
merged 29 commits into from
Jun 8, 2018
Merged

Rewrite2 #27

merged 29 commits into from
Jun 8, 2018

Conversation

StoneyJackson
Copy link
Collaborator

@StoneyJackson StoneyJackson commented Jun 4, 2018

Goals

  • Avoid unsafe operations (e.g., git rebase).
  • Introduce some additional best practices (e.g., git commit -v; checking what files will be committed before committing, and modifying .gitignore if it's wrong.).
  • Reduce the number of different commands required to learn, but possibly require more commands to be issued (e.g., git branch feature; git checkout feature instead of git checkout -b feature; it might seem like the latter is easier, but then you must know the purpose of -b, and when to leave it off).
  • Rely on more external resources for instructions and provide more links to other resources.

To-do

  • Create contributor guide
  • Create maintainer guide
  • Delete old reference
  • Rewrite activity
  • Link activity to steps in contributor guide.
  • Link activity to steps in maintainer guide.
  • Rewrite presentation.pptx
  • Update README
  • Add license to each file
  • Address feedback
  • Tag master as v1.0.0

Issues

The existing workflow suggests using error prone commands such
as `git rebase`. This workflow avoids such commands and tries
to infuse other best practices.
- Add a horizontal rule before details section
- Add bold to note at the top
- Remove meta comment at the top
@StoneyJackson StoneyJackson mentioned this pull request Jun 4, 2018
- Remove squash since this can be done by the maintainer
  when accepting a pull-request.
- Move multi-round before conflict since it is easier
  and gives participants a chance to practice the basic
  workflow before having to deal with a conflict.
- Minor renames in contributor.md.
@StoneyJackson
Copy link
Collaborator Author

@burdged - I decided to give this activity a full overhaul. What do you think? Can we merge it to master and use it in a couple weeks?

Push changes is used during work and during cleanup. We're on different branches in each case (feature and master). Rather than specifying each explicitly (`git push origin master` and `git push origin FEATURE_BRANCH`) or asking folks to figure out which branch needs pushing (`git push origin BRANCH_THAT_NEEDS_PUSHING`), we will have them push up all branches with `git push`. It is usually considered best practice not to push all branches in case you are midway through a change in a branch that you don't want pushed. But at this stage, it overcomplicates things.
I changed my mind from the last commit. Rather than use `git push`, wanting to use the best practice of specifying the remote and branch in a push, and believing that students will learn parallel forms faster than variations, I have made two recipes for push: one for pushing the feature branch, and one for pushing master.
The goal is to synchronize master with our repositories. So we need to push to origin after pulling from upstream.
From burged

The formation of teams was already a bullet item in the README -- maybe pull that bulleted item from the README -- it makes more sense for the formation of teams to be here.
@StoneyJackson
Copy link
Collaborator Author

I think I addressed all the issues. I've tagged the current version of master as v1.0.0, so we can easily get back to it if we want it. But I think we're ready to merge.

@StoneyJackson StoneyJackson merged commit 23cd688 into master Jun 8, 2018
@StoneyJackson StoneyJackson deleted the rewrite2 branch June 8, 2018 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant