Commit Graph

32 Commits

Author SHA1 Message Date
Mike McQuaid
13c67e2703
docs/vale-styles: fix configuration.
Use new scope syntax and fix errors.
2023-07-25 15:28:29 +01:00
Mike McQuaid
ac0665daff
Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Mike McQuaid
a84a20e97b
.github/: defer to Homebrew/.github repo.
This allows maintaining more settings in one place.
2019-05-23 09:46:28 +02:00
EricFromCanada
31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
JBallin
4141c494d9 Link first-timers to "How To Open A Homebrew Pull Request" 2018-08-17 12:53:12 -07:00
Mike McQuaid
f2ce6489b2 Use more docs.brew.sh short links
These are nicer on the eyes.
2018-02-22 19:46:58 +00:00
Hassan F
1926f152e4
Added Periods 2017-11-07 18:57:30 -08:00
Hassan F
af161082dd
Capitalized words
Capitalized beginning of each bullet point to match style of README.md
2017-10-31 20:21:03 -07:00
Cody Lewis
8e82c2ba94 fixed link to CODE_OF_CONDUCT.md within CONTRIBUTING.md
fixed link url to navigate to main brew repo instead of forked repo
2017-10-04 14:57:24 -05:00
Mike McQuaid
baa61f5a6e Use https for all docs.brew.sh links.
May as well use the more secure link when possible.
2017-07-27 15:59:37 +01:00
Mike McQuaid
a3bffe70bc Use docs.brew.sh links. 2017-01-04 11:13:41 +00:00
Mike McQuaid
5efea992f0 Tweak issue template and contributing guidelines.
- Note issues may be closed without comment if sufficient information is
  not provided.
- Deprecate Homebrew/brew-evolution, note new feature request flow
- Note some issues should be created on Homebrew/brew
2016-12-13 00:49:57 +00:00
Mike McQuaid
b85ee1cb8f Update documentation links. 2016-09-20 10:41:42 +01:00
Mike McQuaid
bd6fb88ddc Rearrange repository files. 2016-09-20 10:41:42 +01:00
Dominyk Tiller
eae1fe9eea CONTRIBUTING: move to /.github 2016-02-18 08:19:17 +00:00
BrewTestBot
2f22ae240d CONTRIBUTING: clarifications and cleanup.
Closes Homebrew/homebrew#48857.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-12 09:26:18 +00:00
James Elliott
2534884b64 CONTRIBUTING: how to check for existing PRs.
To avoid extra work on the part of contributors and maintainers, this
adds a step to the explanation of how to contribute a fix to a formula,
showing how to check if someone else has already done so, even if it
has not yet finished being tested, reviewed, and released.

Closes Homebrew/homebrew#48879.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-11 20:48:34 +00:00
Mike McQuaid
b745546943 Overhaul, simplify and cleanup documentation.
Remove duplication, link to the API documentation more often,
tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s
and `@adamv`'s significant past contributions to Homebrew, delete some
outdated or unneeded documentation, add some missing `Formula` API.
entries and simplify/improve `CONTRIBUTING.md`.

Closes Homebrew/homebrew#46179.

Closes Homebrew/homebrew#46618.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-07 13:37:49 +00:00
Mike McQuaid
74e407dc54 The Formula API is no longer work-in-progress.
Feature it a bit more prominently in the documentation as a result.

Closes Homebrew/homebrew#45374.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-27 10:45:23 -06:00
Mike McQuaid
6663e1bd6f Cleanup root documentation. 2014-10-26 15:23:42 +00:00
Mike McQuaid
19d12aee45 Import docs from wiki.
Closes Homebrew/homebrew#33211.
2014-10-26 14:57:36 +00:00
Jack Nagel
93f7f2e950 Add security contact 2014-10-22 17:23:29 -05:00
Mike McQuaid
b4b0bda4aa CONTRIBUTING: fix dashes. 2014-07-13 11:07:21 -07:00
Mike McQuaid
270623c5e3 CONTRIBUTING: link to PR guide. 2014-07-13 11:05:01 -07:00
Mike McQuaid
311dd6f5e8 CODEOFCONDUCT: add Homebrew CoC, diversity doc.
Add the Homebrew Code of Conduct and Diversity statement.

These are heavily based on those created by Python:
http://www.python.org/psf/codeofconduct/
http://www.python.org/community/diversity/

Closes Homebrew/homebrew#26904.
2014-02-23 11:49:32 +00:00
Mike McQuaid
c91d0a99e2 CONTRIBUTING: shorten troubleshooting wording. 2014-01-19 10:06:46 -08:00
Mike McQuaid
5f060a09ff CONTRIBUTING: add Ruby style guide. 2014-01-05 14:43:37 +00:00
Mike McQuaid
157b1ecfec Add brew update to CONTRIBUTING file. 2013-12-21 12:24:45 +00:00
Mike McQuaid
4c2e7b1659 Update docs, comment mxcl/homebrew refs. 2013-12-14 18:18:35 +00:00
Mike McQuaid
2c7ac3c244 CONTRIBUTING: actually fix this time. 2013-01-22 09:47:37 +00:00
Rory O’Kane
7a685856c5 CONTRIBUTING: fix link to Acceptable Formulae.
To match the recent renaming of that wiki article.

Closes Homebrew/homebrew#17249.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2013-01-22 08:54:07 +00:00
Mike McQuaid
518fa7a7e3 Add Contributing Guidelines. 2012-10-03 00:04:24 +01:00