diff options
| author | Dominyk Tiller | 2015-01-02 14:49:41 +0000 |
|---|---|---|
| committer | Mike McQuaid | 2015-01-02 17:13:23 +0000 |
| commit | c4cd8d27c4203d77db98b044d40b230f2a24a368 (patch) | |
| tree | cacc1974aef6d2676dfc50bcfbc30411ff0aa42b /share/doc | |
| parent | eaa8ba1ea5f8a0832fa2ff6cfafb6d8d6f97ce91 (diff) | |
| download | homebrew-c4cd8d27c4203d77db98b044d40b230f2a24a368.tar.bz2 | |
Maintainer-Guidelines: basic touch-up
* Moved the `pip` homepage to something that points more directly at
`pip`.
* Adds a note on `test do`. All the maintainers and the bot check the
existence of such things these days, but I guess if anyone stumbles
across the document it’s useful to say.
* GiX is formally dead, and has two blessed forks.
* Typo on contributor.
Closes #35467.
Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
Diffstat (limited to 'share/doc')
| -rw-r--r-- | share/doc/homebrew/Maintainer-Guidelines.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/share/doc/homebrew/Maintainer-Guidelines.md b/share/doc/homebrew/Maintainer-Guidelines.md index c7fa58c74..514095331 100644 --- a/share/doc/homebrew/Maintainer-Guidelines.md +++ b/share/doc/homebrew/Maintainer-Guidelines.md @@ -16,7 +16,7 @@ This is all that really matters: - Ensure it is not a library that can be installed with [gem](http://en.wikipedia.org/wiki/RubyGems), [cpan](http://en.wikipedia.org/wiki/Cpan) or - [pip](https://crate.io). + [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 @@ -79,6 +79,7 @@ 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 @@ -96,7 +97,7 @@ try to make this work. ## Common “Gotchas” 1. [Ensure you have set your username and email address properly](http://help.github.com/git-email-settings/) -2. Sign off cherry-picks if you amended them (GitX can do this, +2. Sign off cherry-picks if you amended them, [GitX-dev](https://github.com/rowanj/gitx) can do this, otherwise there is a command line flag for it) 3. If the commit fixes a bug, use “Fixes \#104” syntax to close the bug report and link to the commit @@ -115,7 +116,7 @@ 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 pulled, we can’t go back on that willy-nilly. -If it dupes anything ask another comtributor first. Some dupes are okay, +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. |