admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Maintainer-Guidelines: general updates, cleanup.

Browse Source
This commit is contained in:
Mike McQuaid 2015-05-27 11:10:06 +01:00
parent aac0e4a878
commit ebf82e03df
1 changed files with 44 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
share/doc/homebrew/Maintainer-Guidelines.md
View File

@ -17,23 +17,20 @@ This is all that really matters:
[gem](https://en.wikipedia.org/wiki/RubyGems),
[cpan](https://en.wikipedia.org/wiki/Cpan) or
[pip](https://pip.pypa.io/en/latest).
- Ensure the name is not in Ruby’s stdlib (Try
`Formula.factory('readline')` in the `brew irb` shell)
- Ensure that any dependencies are accurate
- Ensure that any dependencies are accurate and minimal. We don't need to
support every possible optional feature for the software.
- Use `brew pull` when possible to add messages to auto-close pull requests (which may take ~5m, be patient) and pull bottles built by BrewTestBot.
- Thank people for contributing.
You should test the build process. But you’re really pressed for time,
just get it in there and let someone else test the build.
Checking deps is important, because they will probably stick around
Checking dependencies is important, because they will probably stick around
forever. Nobody really checks if they are necessary or not. Use the
`:optional` and `:recommended` modifiers as appropriate.
Depend on as little stuff as possible. Avoid X11 functionality unless it
is required. For example, we build Wireshark, but not the monolithic
GUI. If users want that, they should just grab the DMG that Wireshark
themselves provide.
Depend on as little stuff as possible. Disable X11 functionality by default.
For example, we build Wireshark, but not the monolithic GUI. If users want
that, they should just grab the DMG that Wireshark themselves provide.
Homebrew is about UNIX software. Stuff that builds to an `.app` should
Homebrew is about Unix software. Stuff that builds to an `.app` should
be accepted frugally. That is, rarely.
### Naming
@ -43,25 +40,25 @@ Choose a name that’s the colloquial (most common) name for the project.
For example, we chose `objective-caml`, but we should have chosen `ocaml`.
Choose what people say to each other when talking about the project.
Add other names as aliases with the `aka` class function. Ensure the
name referenced on the homepage is one of these, as it may be different
and have underscores and hyphens and so on.
Add other names as aliases as symlinks in `Library/Aliases`. Ensure the name
referenced on the homepage is one of these, as it may be different and have
underscores and hyphens and so on.
We don’t allow versions in formula names (e.g. `bash4.rb`). This is
sometimes frustrating, but we’re trying to solve this properly.
(`python3.rb` is a rare exception, because it’s basically a “new”
language and installs no conflicting executables.)
We don’t allow versions in formula names (e.g. `bash4.rb`); these should be in
the `homebrew/versions` tap. This is sometimes frustrating, but we’re trying to
solve this properly. (`python3.rb` is a rare exception, because it’s basically
a “new” language and installs no conflicting executables.)
For now, if someone submits a formula like this, we’ll leave them in
their own tree.
### Merging, rebasing, cherry-picking
Merging is mainly useful when new work is being done. Please `rebase` or
cherry-pick contributions rather than fill our tree up with noisy merge
commits.
Merging is mainly useful when new work is being done. Please use `brew pull`
(or `rebase`/`cherry-pick` contributions) rather than fill Homebrew's Git
history up with noisy merge commits.
Don’t `rebase` until you finally `push`. Once pushed, you can’t `rebase`
: **you’re a maintainer now!**
Don’t `rebase` until you finally `push`. Once `master` is pushed, you can’t
`rebase` : **you’re a maintainer now!**
Cherry-picking changes the date of the commit, which kind of sucks.
@ -73,13 +70,13 @@ not confusing.
### Testing
We need to at least check it builds. Use [Brew Test Bot](Brew-Test-Bot.md) for this.
Verify the formula works if possible. If you can’t tell—for example, if
it’s a library—trust the original contributor, it worked for them, so
chances are it is fine. If you aren’t an expert in the tool in question,
you can’t really gauge if the formula installed the program correctly.
At some point an expert will come along, cry blue murder that it doesn’t
work, and fix it. This is how open source works.
Ideally, request a `test do` block to test that functionality is consistently available.
Verify the formula works if possible. If you can’t tell (e.g. if it’s a
library) trust the original contributor, it worked for them, so chances are it
is fine. If you aren’t an expert in the tool in question, you can’t really
gauge if the formula installed the program correctly. At some point an expert
will come along, cry blue murder that it doesn’t work, and fix it. This is how
open source works. Ideally, request a `test do` block to test that
functionality is consistently available.
If the formula uses a repository, then the `url` parameter should have a
tag or revision. `url` s have versions and are stable (not yet
@ -106,19 +103,18 @@ try to make this work.
Often parallel builds work with 2-core systems, but fail on 4-core
systems.
### Dupes
The main branch avoids dupes as much as possible. The exception is
### Duplicates
The main repository avoids duplicates as much as possible. The exception is
libraries that OS X provides but have bugs, and the bugs are fixed in a
newer version. Or libraries that OS X provides, but they are too old for
some other formula.
some other formula. The rest should be in the `homebrew/dupes` tap.
Still determine if it possible to avoid the dupe. Be thorough. Duped
libs and tools cause bugs that are tricky to solve. Once the formula is
Still determine if it possible to avoid the duplicate. Be thorough. Duped
libraries and tools cause bugs that are tricky to solve. Once the formula is
pulled, we can’t go back on that willy-nilly.
If it dupes anything ask another contributor first. Some dupes are okay,
some can cause subtle issues we don’t want to have to deal with in the
future.
If it duplicates anything ask another maintainer first. Some dupes are okay,
some can cause subtle issues we don’t want to have to deal with in the future.
Dupes we have allowed:
- `libxml` \<— OS X version is old and buggy
@ -135,15 +131,7 @@ Amend a cherry-pick to remove commits that are only changes in
whitespace. They are not acceptable because our history is important and
`git blame` should be useful.
Whitespace corrections (to ruby standard etc.) are allowed (in fact this
Whitespace corrections (to Ruby standard etc.) are allowed (in fact this
is a good opportunity to do it) provided the line itself has some kind
of modification that is not whitespace in it. But be careful about
making changes to inline patches—make sure they still apply.
This rule is why the `case` statement in the `brew` tool is a mess.
We’ll fix such things up for v2.
### Moving formulae from one tap to another
And preserving the history. I made a
[gist](https://gist.github.com/samueljohn/5280700) about this, based on
Jack’s initial version.