From b89dadaaf012afee91faaaa072458ac415a528bb Mon Sep 17 00:00:00 2001 From: Thomas Lockney Date: Tue, 24 Jan 2017 14:43:06 -0800 Subject: [PATCH 1/2] Adding MIT license --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..650a3df --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2014 Neovim contributors. http://neovim.io + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. From 6b2a9ad59ecf1e4946102275dbfdd52319f10178 Mon Sep 17 00:00:00 2001 From: Thomas Lockney Date: Tue, 24 Jan 2017 14:47:49 -0800 Subject: [PATCH 2/2] Added a few more necessary bits and pieces --- CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ README.md | 14 ++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f54452e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +# Nike Homebrew Tap Changelog / Release Notes + +All notable changes to `homebrew-nike` will be documented in this file. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6601e86 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# How to contribute + +There are a few guidelines that we need contributors to follow so that we are able to process requests as efficiently as possible. If you have any questions or concerns please feel free to contact us at [opensource@nike.com](mailto:opensource@nike.com). + +## Getting Started + +* Review our [Code of Conduct](https://github.com/Nike-Inc/nike-inc.github.io/blob/master/CONDUCT.md) +* Submit the [Individual Contributor License Agreement](https://www.clahub.com/agreements/Nike-Inc/riposte) +* Make sure you have a [GitHub account](https://github.com/signup/free) +* Submit a ticket for your issue, assuming one does not already exist. + * Clearly describe the issue including steps to reproduce when it is a bug. + * Make sure you fill in the earliest version that you know has the issue. +* Fork the repository on GitHub + +## Making Changes + +* Create a topic branch off of `master` before you start your work. + * Please avoid working directly on the `master` branch. +* Make commits of logical units. + * You may be asked to squash unnecessary commits down to logical units. +* Check for unnecessary whitespace with `git diff --check` before committing. +* Write meaningful, descriptive commit messages. +* Please follow existing code conventions when working on a file. + +## Submitting Changes + +* Push your changes to a topic branch in your fork of the repository. +* Submit a pull request to the repository in the Nike-Inc organization. +* After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity. +* Bug fixes or features that lack appropriate tests may not be considered for merge. +* Changes that lower test coverage may not be considered for merge. + +# Additional Resources + +* [General GitHub documentation](https://help.github.com/) +* [GitHub pull request documentation](https://help.github.com/send-pull-requests/) +* [Nike's Code of Conduct](https://github.com/Nike-Inc/nike-inc.github.io/blob/master/CONDUCT.md) +* [Nike's Individual Contributor License Agreement](https://www.clahub.com/agreements/Nike-Inc/riposte) +* [Nike OSS](https://nike-inc.github.io/) diff --git a/README.md b/README.md index 2dcfb13..1f764f7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ Homebrew formula for Nike OSS projects. +## What is Homebrew? + +Homebrew is an OSX specific application that allows users to install applications that didn't come with Apple's operating system. + +## What is a "tap" and what does it contain? + +A tap in Homebrew is a third-party distribution channel that allows developers to provide installation scripts for their packages that, for one reason or another, are not eligible to be listed in the primary Homebrew distribution channel. + +These taps are simply git repositories that contain Ruby scripts implementing the Homebrew installation interface. + +## What should live in Nike's tap? + +Any project under the Nike-Inc GitHub banner that provides an installable binary or script. + ## Installation To use formula's from Nike OSS projects, you'll need to add this tap to Homebrew: