forked from Nike-Inc/homebrew-nike
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a few more necessary bits and pieces
- Loading branch information
Showing
3 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Nike Homebrew Tap Changelog / Release Notes | ||
|
||
All notable changes to `homebrew-nike` will be documented in this file. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters