This repository has been archived by the owner on Nov 27, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
42 changed files
with
47 additions
and
3,978 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 |
|---|---|---|
| @@ -1,37 +1,6 @@ | ||
| # Contributing to Homebrew | ||
| First time contributing to Homebrew? Read our [Code of Conduct](https://github.com/Homebrew/homebrew/blob/master/CODEOFCONDUCT.md#code-of-conduct). | ||
| **DO NOT CREATE NEW ISSUES OR PULL REQUESTS ON THIS REPOSITORY!** | ||
|
|
||
| ### Report a bug | ||
|
|
||
| * run `brew update` (twice) | ||
| * run and read `brew doctor` | ||
| * read [the Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting) | ||
| * open an issue on the formula's repository | ||
|
|
||
| ### Submit a `1.2.3` version upgrade for the `foo` formula | ||
|
|
||
| * check if the same upgrade has been already submitted by [searching the open pull requests for `foo`](https://github.com/Homebrew/homebrew/pulls?utf8=✓&q=is%3Apr+is%3Aopen+foo). | ||
| * `brew edit foo` | ||
| * edit [`url`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method) and [`sha256`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#sha256%3D-class_method)/[`tag`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#url-class_method), leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is | ||
| * `brew install foo` | ||
| * run `brew audit foo` and fix any issues | ||
| * `git commit` with commit subject `foo 1.2.3` | ||
| * [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests | ||
|
|
||
| ### Add a new formula for `foo` version `2.3.4` from `$URL` | ||
|
|
||
| * read [the Formula Cookbook](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Formula-Cookbook.md#formula-cookbook) or: `brew create $URL` and make edits | ||
| * `brew install foo` | ||
| * `brew audit --online --strict foo` | ||
| * `git commit` with message formatted `foo 2.3.4 (new formula)` | ||
| * [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests | ||
|
|
||
| ### Contribute a fix to the `foo` formula | ||
|
|
||
| * `brew edit foo` and make edits | ||
| * leave the [`bottle`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#bottle-class_method) as-is | ||
| * `brew install foo`, `brew test foo`, and `brew audit foo` | ||
| * `git commit` with message formatted `foo: fix <insert details>` | ||
| * [open a pull request](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/How-To-Open-a-Homebrew-Pull-Request-(and-get-it-merged).md#how-to-open-a-homebrew-pull-request-and-get-it-merged) and fix any failing tests | ||
|
|
||
| Thanks! | ||
| - Please create all issues found when running `brew install` at https://github.com/Homebrew/homebrew-core/issues/new | ||
| - Please create all issues found when running any other `brew` command at https://github.com/Homebrew/brew/issues/new | ||
| - Please create formula pull requests at https://github.com/Homebrew/homebrew-core | ||
| - Please create core code pull requests at https://github.com/Homebrew/brew |
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 |
|---|---|---|
| @@ -1,20 +1,5 @@ | ||
| # Please follow the general troubleshooting steps first: | ||
| DO NOT CREATE NEW ISSUES ON THIS REPOSITORY! | ||
|
|
||
| - [ ] Ran `brew update` and retried your prior step? | ||
| - [ ] Ran `brew doctor`, fixed as many issues as possible and retried your prior step? | ||
| - [ ] If you're seeing permission errors tried running `sudo chown -R $(whoami) $(brew --prefix)`? | ||
| Please create all issues found when running `brew install` at https://github.com/Homebrew/homebrew-core/issues/new | ||
|
|
||
| _You can erase any parts of this template not applicable to your Issue._ | ||
|
|
||
| ### Bug reports: | ||
|
|
||
| Please replace this line with a brief summary of your issue **AND** if reporting a build issue include the link from: | ||
|
|
||
| `brew gist-logs <formula>` | ||
| (where `<formula>` is the name of the formula that failed to build). | ||
|
|
||
| ### Feature/Formula Requests: | ||
|
|
||
| **Please note by far the quickest way to get a new feature or formula into Homebrew is to file a [Pull Request](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md).** | ||
|
|
||
| We will consider your request but it may be closed if it's something we're not actively planning to work on. | ||
| Please create all issues found when running any other `brew` command at https://github.com/Homebrew/brew/issues/new |
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 |
|---|---|---|
| @@ -1,18 +1,5 @@ | ||
| ### All Submissions: | ||
| DO NOT CREATE NEW PULL REQUESTS ON THIS REPOSITORY! | ||
|
|
||
| - [ ] Have you followed the guidelines in our [Contributing](https://github.com/Homebrew/homebrew/blob/master/.github/CONTRIBUTING.md) document? | ||
| - [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/Homebrew/homebrew/pulls) for the same update/change? | ||
| Please create formula pull requests at https://github.com/Homebrew/homebrew-core | ||
|
|
||
| _You can erase any parts of this template not applicable to your Pull Request._ | ||
|
|
||
| ### New Formulae Submissions: | ||
|
|
||
| - [ ] Does your submission pass | ||
| `brew audit --strict --online <formula>` (where `<formula>` is the name of the formula you're submitting)? | ||
| - [ ] Have you built your formula locally prior to submission with `brew install <formula>`? | ||
|
|
||
| ### Changes to Homebrew's Core: | ||
|
|
||
| - [ ] Have you added an explanation of what your changes do and why you'd like us to include them? | ||
| - [ ] Have you written new tests for your core changes, as applicable? [Here's an example](https://github.com/Homebrew/homebrew/pull/49031) if you'd like one. | ||
| - [ ] Have you successfully ran `brew tests` with your changes locally? | ||
| Please create core code pull requests at https://github.com/Homebrew/brew |
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 |
|---|---|---|
| @@ -1,25 +1 @@ | ||
| # Code of Conduct | ||
| The Homebrew community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences great successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines which help steer our interactions and strive to keep Homebrew a positive, successful, and growing community. | ||
|
|
||
| A member of the Homebrew community is: | ||
|
|
||
| ## Open | ||
| Members of the community are open to collaboration, whether it's on GitHub, email, IRC or otherwise. We're receptive to constructive comment and criticism, as the experiences and skill sets of other members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate and everyone can make a difference. | ||
|
|
||
| ## Considerate | ||
| Members of the community are considerate of their peers - other Homebrew users. We're thoughtful when addressing the efforts of others, keeping in mind that oftentimes their labor was completed simply for the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views. | ||
|
|
||
| ## Respectful | ||
| Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments, and their efforts. We're respectful of the volunteer efforts that permeate the Homebrew community. We're respectful of the processes set forth in the community, and we work within them. When we disagree, we are courteous in raising our issues. | ||
|
|
||
| Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally. | ||
|
|
||
| # Diversity | ||
| The Homebrew community welcomes and encourages participation by everyone. Our community is based on mutual respect, tolerance, and encouragement, and we are working to help each other live up to these principles. We want our community to be more diverse: whoever you are, and whatever your background, we welcome you. | ||
|
|
||
| We have created this diversity statement because we believe that a diverse Homebrew community is stronger and more vibrant. A diverse community where people treat each other with respect has more potential contributors and more sources for ideas. | ||
|
|
||
| Although we have phrased the formal diversity statement generically to make it all-inclusive, we recognise that there are specific attributes that are used to discriminate against people. In alphabetical order, some of these attributes include (but are not limited to): age, culture, ethnicity, gender identity or expression, national origin, physical or mental difference, politics, race, religion, sex, sexual orientation, socio-economic status, and subculture. We welcome people regardless of the values of these or other attributes. | ||
|
|
||
| # Attribution | ||
| This code of conduct is heavily based on the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/) and the [Python Diversity Statement](https://www.python.org/community/diversity/). | ||
| Moved to https://github.com/Homebrew/brew/blob/master/CODEOFCONDUCT.md. |
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 |
|---|---|---|
| @@ -1,61 +1,4 @@ | ||
| # Homebrew | ||
| Features, usage and installation instructions are [summarised on the homepage](http://brew.sh). | ||
|
|
||
| ## What Packages Are Available? | ||
| 1. Type `brew search` for a list. | ||
| 2. Or visit [braumeister.org](http://braumeister.org) to browse packages online. | ||
| 3. Or use `brew search --desc` to browse packages from the command line. | ||
|
|
||
| ## More Documentation | ||
| `brew help`, `man brew` or check [our documentation](https://github.com/Homebrew/homebrew/tree/master/share/doc/homebrew#readme). | ||
|
|
||
| ## Troubleshooting | ||
| First, please run `brew update` and `brew doctor`. | ||
|
|
||
| Second, read the [Troubleshooting Checklist](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Troubleshooting.md#troubleshooting). | ||
|
|
||
| **If you don't read these it will take us far longer to help you with your problem.** | ||
|
|
||
| ## Security | ||
| Please report security issues to [email protected]. | ||
|
|
||
| This is our PGP key which is valid until June 17, 2016. | ||
| * Key ID: `0xE33A3D3CCE59E297` | ||
| * Fingerprint: `C657 8F76 2E23 441E C879 EC5C E33A 3D3C CE59 E297` | ||
| * Full key: https://keybase.io/homebrew/key.asc | ||
|
|
||
| ## Who Are You? | ||
| Homebrew's current maintainers are [Misty De Meo](https://github.com/mistydemeo), [Andrew Janke](https://github.com/apjanke), [Xu Cheng](https://github.com/xu-cheng), [Mike McQuaid](https://github.com/mikemcquaid), [Baptiste Fontaine](https://github.com/bfontaine), [Brett Koonce](https://github.com/asparagui), [Martin Afanasjew](https://github.com/UniqMartin), [Dominyk Tiller](https://github.com/DomT4), [Tim Smith](https://github.com/tdsmith) and [Alex Dunn](https://github.com/dunn). | ||
|
|
||
| Former maintainers with significant contributions include [Jack Nagel](https://github.com/jacknagel), [Adam Vandenberg](https://github.com/adamv) and Homebrew's creator: [Max Howell](https://github.com/mxcl). | ||
|
|
||
| ## License | ||
| Code is under the [BSD 2 Clause (NetBSD) license](https://github.com/Homebrew/homebrew/tree/master/LICENSE.txt). | ||
| Documentation is under the [Creative Commons Attribution license](https://creativecommons.org/licenses/by/4.0/). | ||
|
|
||
| ## Donations | ||
| Homebrew is a non-profit project run entirely by unpaid volunteers. We need your funds to pay for software, hardware and hosting around continuous integration and future improvements to the project. Every donation will be spent on making Homebrew better for our users. | ||
|
|
||
| Homebrew is a member of the [Software Freedom Conservancy](http://sfconservancy.org) which provides us with an ability to receive tax-deductible, Homebrew earmarked donations (and [many other services](http://sfconservancy.org/members/services/)). Software Freedom Conservancy, Inc. is a 501(c)(3) organization incorporated in New York, and donations made to it are fully tax-deductible to the extent permitted by law. | ||
|
|
||
| - [Donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=V6ZE57MJRYC8L) | ||
| - Donate by USA $ check from a USA bank: | ||
| - Make check payable to "Software Freedom Conservancy, Inc." and place "Directed donation: Homebrew" in the memo field. Checks should then be mailed to: | ||
| - Software Freedom Conservancy, Inc. | ||
| 137 Montague ST STE 380 | ||
| BROOKLYN, NY 11201 USA | ||
| - Donate by wire transfer: contact [email protected] for wire transfer details. | ||
| - Donate with Flattr or PayPal Giving Fund: coming soon. | ||
|
|
||
| ## Sponsors | ||
| Our CI infrastructure was paid for by [our Kickstarter supporters](https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/Kickstarter-Supporters.md). | ||
|
|
||
| Our CI infrastructure is hosted by [The Positive Internet Company](http://www.positive-internet.com). | ||
|
|
||
| Our bottles (binary packages) are hosted by Bintray. | ||
|
|
||
| [](https://bintray.com/homebrew) | ||
|
|
||
| Homebrew is a member of the [Software Freedom Conservancy](https://sfconservancy.org) | ||
|
|
||
| [](https://sfconservancy.org) | ||
| # Homebrew (Legacy) | ||
| This repository has been deprecated and split into two repositories: | ||
| - [Homebrew/brew](https://github.com/Homebrew/brew): the Homebrew package manager without any formulae/packages (i.e. the former contents of `Library/Formula`) | ||
| - [Homebrew/homebrew-core](https://github.com/Homebrew/homebrew-core): the formulae/packages (i.e. the former contents of `Library/Formula`) for the Homebrew package manager |
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 |
|---|---|---|
| @@ -1,118 +1 @@ | ||
| # Acceptable Formulae | ||
| Some formulae should not go in | ||
| [homebrew/core](https://github.com/Homebrew/homebrew-core). But there are | ||
| additional [Interesting Taps & Branches](Interesting-Taps-&-Branches.md) and anyone can start their | ||
| own! | ||
|
|
||
| ### We try hard to avoid dupes in Homebrew/homebrew | ||
| Stuff that comes with OS X or libraries that are provided by | ||
| [RubyGems, CPAN or PyPi](Gems,-Eggs-and-Perl-Modules.md) | ||
| should not be duplicated. There are good reasons for this: | ||
|
|
||
| * Duplicate libraries regularly break builds | ||
| * Subtle bugs emerge with duplicate libraries, and to a lesser extent, | ||
| duplicate tools | ||
| * We want our formulae to work with what comes with OS X | ||
|
|
||
| There are exceptions: | ||
|
|
||
| * OpenSSL - Apple has formally deprecated OpenSSL on OS X in favour of their own Security Framework | ||
| & consequently the OS X OpenSSL is rarely updated and frequently falls behind important security updates. | ||
| Homebrew endeavours to use our shipped OpenSSL as much | ||
| as possible. | ||
| * Programs that a user will regularly interact with directly, like editors and | ||
| language runtimes | ||
| * Libraries that provide functionality or contain security updates not found in | ||
| the system version | ||
| * Things that are **designed to be installed in parallel to earlier versions of | ||
| themselves** | ||
|
|
||
| #### Examples | ||
|
|
||
| Formula | Reason | ||
| --- | --- | ||
| ruby, python, perl | People want newer versions | ||
| bash | OS X's bash is stuck at 3.2 because newer versions are licensed under GPLv3 | ||
| zsh | This was a mistake, but it’s too late to remove it | ||
| emacs, vim | [Too popular to move to dupes](https://github.com/Homebrew/homebrew/pull/21594#issuecomment-21968819) | ||
| subversion | Originally added for 10.5, but people want the latest version | ||
| libcurl | Some formulae require a newer version than OS X provides | ||
| openssl | OS X's openssl is deprecated & outdated. | ||
| libxml2 | Historically, OS X's libxml2 has been buggy | ||
|
|
||
| We also maintain [a tap](https://github.com/Homebrew/homebrew-dupes) that | ||
| contains many duplicates not otherwise found in Homebrew. | ||
|
|
||
| ### We don’t like tools that upgrade themselves | ||
| Software that can upgrade itself does not integrate well with Homebrew's own | ||
| upgrade functionality. | ||
|
|
||
| ### We don’t like install-scripts that download things | ||
| Because that circumvents our hash-checks, makes finding/fixing bugs | ||
| harder, often breaks patches and disables the caching. Almost always you | ||
| can add a resource to the formula file to handle the | ||
| separate download and then the installer script will not attempt to load | ||
| that stuff on demand. Or there is a command line switch where you can | ||
| point it to the downloaded archive in order to avoid loading. | ||
|
|
||
| ### We don’t like binary formulae | ||
| Our policy is that formulae in the core repository | ||
| ([homebrew/core](https://github.com/Homebrew/homebrew-core)) must be built | ||
| from source (or produce cross-platform binaries like e.g. Java). Binary-only | ||
| formulae should go to [homebrew/binary](https://github.com/Homebrew/homebrew-binary) or [homebrew-cask](https://github.com/caskroom/homebrew-cask). | ||
|
|
||
| ### Stable versions | ||
| Formulae in the core repository must have a stable version tagged by | ||
| the upstream project. Tarballs are preferred to git checkouts, and | ||
| tarballs should include the version in the filename whenever possible. | ||
|
|
||
| Software that only provides a development/beta, tagged version should be put in | ||
| [homebrew/devel-only](https://github.com/Homebrew/homebrew-devel-only). | ||
| We don’t accept software without a tagged version because they regularly break | ||
| due to upstream changes; we can’t provide [bottles](Bottles.md) for them; and | ||
| we don’t have an automatic update mechanism for `head-only` formulae which | ||
| makes them very quickly outdated. | ||
|
|
||
| ### Bindings | ||
| First check that there is not already a binding available via | ||
| [`gem`](https://rubygems.org/) or [`pip`](http://www.pip-installer.org/) | ||
| etc.. | ||
|
|
||
| If not, then put bindings in the formula they bind to. This is more | ||
| useful to people. Just install the stuff! Having to faff around with | ||
| foo-ruby foo-perl etc. sucks. | ||
|
|
||
| ### Niche (or self-submitted) Stuff<a name="Niche_Stuff"></a> | ||
| The software in question must be | ||
| * maintained (e.g. upstream is still making new releases) | ||
| * known | ||
| * stable (e.g. not declared "unstable" or "beta" by upstream) | ||
| * used | ||
| * have a homepage | ||
|
|
||
| We will reject formulae that seem too obscure, partly because they won’t | ||
| get maintained and partly because we have to draw the line somewhere. | ||
|
|
||
| We frown on authors submitting their own work unless it is very popular. | ||
|
|
||
| Don’t forget Homebrew is all `git` underneath! Maintain your tap if you have to! | ||
|
|
||
| There may be exceptions to these rules in the main repository, we may | ||
| include things that don't meet these criteria or reject things that do. | ||
| Please trust that we need to use our discretion based on our experience | ||
| running a package manager. | ||
|
|
||
| ### Stuff that builds a .app | ||
| Don’t make your formula build an `.app` (native OS X Application); we | ||
| don’t want those things in Homebrew. Make it build a command line tool | ||
| or a library. However, we have a few exceptions to that, e.g. when the | ||
| App is just additional to CLI or if the GUI-application is non-native | ||
| for OS X and/or hard to get in binary elsewhere (example: fontforge). | ||
| Check out the [homebrew-cask](https://github.com/caskroom/homebrew-cask) | ||
| project if you’d like to brew native OS X Applications. | ||
|
|
||
| ### Sometimes there are exceptions | ||
| Even if all criteria are met we may not accept the formula. | ||
| Documentation tends to lag behind current decision-making. Although some | ||
| rejections may seem arbitrary or strange they are based from years of | ||
| experience making Homebrew work acceptably for our users. | ||
| Moved to https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Acceptable-Formulae.md. |
Oops, something went wrong.