Skip to content

Commit

Permalink
updates to turnerlabs and removes unnecessary cmds (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
jritsema authored May 2, 2018
1 parent a2d709b commit d0c7cb4
Show file tree
Hide file tree
Showing 80 changed files with 91 additions and 9,314 deletions.
42 changes: 0 additions & 42 deletions CODE_OF_CONDUCT.md

This file was deleted.

46 changes: 29 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
**Welcome!** Thank you for considering contributing to this project! If I can
help in anyway to get you going, please feel free to reach out. I'm available by
email and Google Hangouts at john@pignata.com.
# How to contribute

# Contributing
Thanks for your interest in the project! We want to welcome contributors so we put together the following set of guidelines to help participate.

## Workflow

Expand All @@ -21,7 +19,7 @@ email and Google Hangouts at john@pignata.com.

## Setup

- Ensure you're using golang 1.9+.
- Ensure you're using golang 1.10+.

```console
go version
Expand All @@ -33,13 +31,13 @@ email and Google Hangouts at john@pignata.com.
- Install the source code from GitHub

```console
go get github.com/jpignata/fargate
go get github.com/turnerlabs/fargate
```

- Run `dep ensure` to install required dependencies

```console
cd $GOPATH/src/github.com/jpignata/fargate
cd $GOPATH/src/github.com/turnerlabs/fargate
dep ensure
```

Expand All @@ -63,17 +61,31 @@ email and Google Hangouts at john@pignata.com.
- For cross-building for all supported platforms, run `make dist` which builds
binaries for darwin (64-bit) and linux (Arm, 32-bit, 64-bit).

## Licensing
## Making Changes

This project is released under the [Apache 2.0 license][apache].
* Create a feature branch from where you want to base your work.
* This is usually the `develop` branch.
* To quickly create a feature branch; `git checkout -b feature/my-feature`. Please avoid working directly on the
`master` branch.
* Make commits of logical units.
* Run `go fmt ./cmd` before committing.
* Make sure you have added the necessary tests for your changes.
* Run _all_ the tests to assure nothing else was accidentally broken.

## Submitting Changes

* Push your changes to a feature branch in your fork of the repository.
* Submit a pull request to the `develop` branch to the repository in the turnerlabs organization.

## Code of Conduct
## Release Process

This project abides by the [Amazon Open Source Code of Conduct][amzn-coc].
Please be nice.
* After a feature pull request has been merged into the `develop` branch, a CI build will be automatically kicked off. The CI build will run unit tests, do a multi-platform build and automatically deploy the build to the [Github releases](https://github.com/turnerlabs/fargate/releases) page as a pre-release using the latest tag (`git describe --tags`) as the version number.
* After the core team decides which features will be included in the next release, a release branch is created (e.g., `release/v0.5`) from develop.
* The `CHANGELOG.md` file is updated to document the release in the release branch.
* The release branch is merged to `master`, tagged, and pushed (along with tags).
* This will kick off a build that builds using the latest tag and deploys as a Github release.
* The release branch is then merged back to `develop`, tagged for pre-release (to start next version, e.g. v0.6.0-pre) and pushed.

[dep]: https://golang.github.io/dep
[dep-install]: https://golang.github.io/dep/docs/installation.html
[dep-releases]: https://github.com/golang/dep/releases
[amzn-coc]: https://aws.github.io/code-of-conduct
[apache]: http://aws.amazon.com/apache-2-0/
## Licensing

This project is released under the [Apache 2.0 license][apache].
Loading

0 comments on commit d0c7cb4

Please sign in to comment.