Skip to content

Commit

Permalink
Fixed merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyoverman committed Oct 24, 2017
2 parents ed4cd66 + fa65ab0 commit 1971637
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 14 deletions.
35 changes: 35 additions & 0 deletions BRANCHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Branching

An overview of how this project handles branching.

## Feature branch

When a contributor wishes to make a change on the repository, they must first checkout develop, pull the latest version, then create a feature branch from develop.

The branch name should look something like this:

`issue-8-short-description-of-change`

If there is an issue on the latest production branch, we may create a branch off of master.

## Pull Request

Once the feature branch is complete, a pull request must be made to the appropriate branch -- develop for a feature, or master for a hotpatch.

The pull request must pass the Semaphore build before being merged in. When mergeing, the commit message must follow the following conventions:

| Message | Release Type | Description |
|----------|--------------|-----------------------------------------------|
| feat | Minor | A new feature being added to the application |
| fix | Patch | A bug fix |
| perf | Patch | A performance issue fix |

The commit message must look like this:

`message: a short description (issue-#)`

## Deployment

When we are ready to cut a release for deployment, we must checkout the master branch, merge develop into master, then push master to origin.

This will kick off the Semaphore build and, if successful, will create a new release and publish to the NPMJS Registry for us.
13 changes: 0 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,6 @@ Branches should include the issue number they are related to. We will not accept

Once we are ready to release the new package, we will then merge develop into master, and our test suite will be run and, if successful, a new release will be made

## Commits

We will be following the following commit scheme:

| Message | Release Type | Description |
|----------|--------------|-----------------------------------------------|
| Breaking | Major | Changes that break the current implementation |
| Fix | Minor | Bug fixes |
| Update | Minor | Updating features of the application |
| New | Minor | Creating new features for the application |

When you create your branch, feel free to commit as often as you like with whatever commit messages you see fit on your branch. When you submit your pull request and it is approved, the merger will squash your commits into a single commit with the correct message and merge it in.

## Compiling

This project uses typescript, and files must be compiled before they can be run. To install typescript on your machine, you can run the command `npm install typescript -g`, and once installed you can compile by running the command `tsc`, or you may run `tsc -w` to watch for changes and compile of file change.
Expand Down
6 changes: 5 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,4 +227,8 @@ If an `arg` that is required is not passed into the command chain, a usage help
Usage: template template [otherarg]

template The name of the template to generate
otherarg Another optional argument
otherarg Another optional argument

# Contributing

We welcome contributors to open issues or submit pull requests. Please check out our [contributing page](https://github.com/jeremyoverman/action-runner/blob/develop/CONTRIBUTING.md) for more information.

0 comments on commit 1971637

Please sign in to comment.