Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 2.01 KB
Raw

Contributing to Cisco Open Homebrew Tap

First time contributing to Cisco Open Homebrew Tap? Read our Code of Conduct.

Thank you for contributing!

Report a bug

  • Make sure you have the latest version of Homebrew installed: brew update
  • Open an issue reporting the bug you are facing

Add a new formulae

  • Make sure you have the latest version of Homebrew installed: brew update
  • Retrieve this repository via git using brew tap cisco-open/tap git@github.com:cisco-open/homebrew-tap.git
  • Create a formula with brew create --tap cisco-open/tap --set-name foo https://github.com/cisco-open/<project>/archive/refs/tags/<thing>.tar.gz
  • read the Formula Cookbook and make edits
  • Review the checklist for PRs and make sure that you can check all of them
  • git commit with a message that contains the name of the formula and the version (e.g. foo 2.3.4)
  • open a pull request and fix any failing tests

Update or fix an existing formulae

  • Make sure you have the latest version of Homebrew installed: brew update
  • Retrieve this repository via git using brew tap cisco-open/tap git@github.com:cisco-open/homebrew-tap.git
  • Make edits to fix the existing formulae
  • Review the checklist for PRs and make sure that you can check all of them
  • run git commit with message that contains the name of the formula and the (updated) version (e.g. foo <insert new version number> or foo 2.3.4: <insert details>)
  • open a pull request as described in the introduction linked to above, wait for the automated test results, and fix any failing tests

Acknowledgement

This contribution guidelines have been inspired by the Homebrew Core Contributing Guidelines