Skip to content

Instantly share code, notes, and snippets.

View js62789's full-sized avatar

Jeffrey Smith js62789

7 followers · 2 following
  • GasBuddy LLC
  • Boston, MA
View GitHub Profile
@js62789
js62789 / DirectoryStructure.md
Last active August 29, 2015 13:57
A directory structure for robust web apps

##Directory Structure

|--test/
|  |--spec/
|  |  |--test.js
|--public/
|  |--scripts/
|  |  |--project_name/
|  |  |  |--models/
| | | |--views/
@js62789
js62789 / WebAppTools.md
Last active August 29, 2015 13:57
A list of tools and why they're useful to web app development
@js62789
js62789 / GithubWorkflow.md
Last active January 12, 2023 15:41
Commit, review, and merge conventions

Github Workflow

Branching

When working on an issue, create a branch specific to that feature/bug. If two people are working on the same feature, they should each have a branch off of the feature branch. There should be a naming convention in place. The name of the branch should contain sufficient detail as to the purpose of that branch. For example, you may want to include the identity of the creator of the branch name so that colleagues know who the branch belongs to. You may want to have a segment that identifies the task being accomplished or the date started. An example of a naming convention would look like feature_{TASK_ID} or {YOUR_INITIALS}_{TASK_NAME}.

Commit

The title of the commit can be anything you want. Including an integration in the title is only necessary if the pull request's title will not suffice. If you believe a series of commits can/should be combined into a single commit, you can use rebase, merge --squash, or reset methods. This is commonly referred to as [squash