Skip to content

Latest commit

 

History

History
86 lines (49 loc) · 3.55 KB

contribute.md

File metadata and controls

86 lines (49 loc) · 3.55 KB

##Project tools

####Git-Splainin

This is a way to create Pull Request templates that can be used across the entire team and make it really easy to populate PR forms. It is a really great tool developed as a chrome extension. You can find it at the webstore.

Get Git-Splainin

####Getting Floobits

Floobits is awesome platform to collaboratively create and edit associated with the project. The repo is created as a workspace and then you connect your editor to the workspace. You will then have your sublime text/Atom/whatever be like google docs for code writing.

Floobits project_url This project url is on the organization repo on the floo branch.

set-up instruction

##Github Tools:

Github Guide to Issues and Milestones

####Milestones:

Milestones are an excellent way to contain tasks or issues associated with a feature. Milestones have a title, description and due-date. Github issues can be added to milestones.

####Pull Requests and Issues

Github issues and pull requests are a great way manage the development of a project. Issues are created with atomic feature additions or bugs. Pull requests are the means to merge development effort into master branch for production.

Issue definitions should be small and atomic. This is important so they can represent small, focused changes in code which are in turn encapsulated by small focused commits. Pull requests should be created with the specific issue or set of issues they address. It is possible to create the Pull Request before the issues are completed and create the points they will address as checkboxes.

Task lists in issues and PRs

Issues can have labels, assignees, and milestones.

Both issues an pull requests can have comment threads. All issues related communication should be kept with the issue on github. Issues can be linked from other issues. This is a great way to estabish relationships between related issues.

Also, it is possible to reference issues from commit messages to either close or reference them.

Closing issues from commits

Linking issues with mentions

Plausible Yeti Git Workflow

  1. GITHUB: Fork plausibleyeti/client-recon 0.1.LOCAL: git clone user/client-recon 0.2.LOCAL: git remote add upstream plausibleyeti/client-recon

  2. Find issue that you were assigned a. Or Assign issue to yourself

  3. LOCAL || git status to make sure you are on master

  4. LOCAL || git pull --rebase usptream master => makes sure master is up to date with truth

  5. LOCAL || git checkout -b feature-IssueThatYouWereAssigned

  6. GITHUB || pull request Create initial pull request with Task list of issues

  7. LOCAL || git status => to check branch

  8. Cyclical a. make edits b. git add c. git commit

  9. LOCAL || git pull --rebase upstream master

  10. LOCAL || git push origin feature-IssueThatYouWereAssigned

  11. GITHUB || pull request finalize and assign

  12. IF MAKING Changes to pull request a. LOCAL || make changes locally b. LOCAL || git add c. LOCAL || git commit d. LOCAL || git pull --rebase upstream master e. LOCAL || git push origin feature-IssueThatYouWereAssigned

SCRUM MASTER // SECOND SET OF EYES

  1. review changes and merge
  2. merge request