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: