Skip to content

Commit

Permalink
Merge pull request #27 from StoneyJackson/rewrite2
Browse files Browse the repository at this point in the history
# Version 2.0.0

## 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

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

## Issues

- Closes #25 because they are now asked to add a license
- Closes #22 because reflection subsections are added to each section
- Closes #21 because there are now different guides for different roles
- Closes #24 because <MY_URL> and <THEIR_URL> are gone; although folks could still get confused by all caps placeholders even though they are explained at the beginning of the guide.
- Closes #18 because no paths are given
- Closes #20 because I gave a new guess to the time requirements.
- Closes #23 because there are now each section ends with reflection questions which are times for group discussions.
- Closes #31 
- Closes #30 
- Closes #29
- Closes #32
- Closes #33 
- Closes #34
  • Loading branch information
StoneyJackson authored Jun 8, 2018
2 parents edcd4b1 + 921c98f commit 23cd688
Show file tree
Hide file tree
Showing 7 changed files with 610 additions and 329 deletions.
5 changes: 2 additions & 3 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Copyright 2016, Darci Burdge and Stoney Jackson
Copyright 2018 Darci Burdge and Stoney Jackson SOME RIGHTS RESERVED

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/.
This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ .
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,33 @@ Participants will be able to:
- Prepare a fork and local repository to contribute changes to upstream project on GitHub
- Fork a project on GitHub
- Clone a local repository from a remote repository
- Create a remote in local repository to a remote repository
- Connect local repository to remote repository
- Prepare a branch to work on a feature or bug
- Create a local branch
- Push a local branch to a remote
- Issue a pull-request on GitHub
- Update repository with changes from upstream
- Fetch upstream changes into local repository
- Rebase feature branch onto upstream development branch
- Pull upstream changes into local repository
- Merge master into feature branch
- Resolve conflicts
- Push changes to remote
- Force push changes to remote
- Squash commits

## Contents

- activity.md - Activity participants work through.
- presentation.pptx - Overview presentation of workflow.
- reference.md - Detailed description of the workflow.
- [activity.md](activity.md) - Activity participants work through.
- [contributor.md](contributor.md) - Contributors' Guide.
- [maitainer.md](maintainer.md) - Maintainers' Guide.
- [presentation.pptx](presentation.pptx) - Overview presentation of workflow.

## Facilitation

- 10 min:
- ___Quickly___ presentation.pptx
- Form teams
- Hand out activity.md and reference.md, one hardcopy per team
- 50-70 min:
- 10-20 min:
- ___Quickly___ review presentation.pptx with class
- 60-80 min:
- Teams work through activity.md

## License
## Copyright and Licensing

(c) 2016 Darci Burdge and Stoney Jackson SOME RIGHTS RESERVED
Copyright 2018 Darci Burdge and Stoney Jackson SOME RIGHTS RESERVED

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ .
Loading

0 comments on commit 23cd688

Please sign in to comment.