| 1 | # Contributing to open hoagie |
| 2 | |
| 3 | First: thank you. Every layer counts -- except the onion loophole, which |
| 4 | is currently under review and should stay that way. |
| 5 | |
| 6 | ## Getting set up |
| 7 | |
| 8 | 1. Clone the repository. |
| 9 | 2. Wash your hands. This is a site of food. |
| 10 | 3. If you are carrying an onion, raise it BEFORE you commit it. |
| 11 | |
| 12 | ## How to add a layer |
| 13 | |
| 14 | - Fork the hoagie. |
| 15 | - Branch off `main`: `feature/<layer-name>`. |
| 16 | - Test locally. In food terms, testing locally means: on a plate, with a |
| 17 | napkin, at your own table, during your own lunch hour. |
| 18 | - Open a PR against `main`. In food terms, a "PR" is the queue at the |
| 19 | deli counter: you join the queue at the back and you wait your turn. |
| 20 | Nobody eats until everyone is served. |
| 21 | |
| 22 | ## Definition of done |
| 23 | |
| 24 | A contribution is done when: |
| 25 | |
| 26 | - It tastes good. You have to confirm this out loud, in the PR. |
| 27 | - It does not make the bread soggy. Sogginess is an O(n) fail. |
| 28 | - It compiles -- i.e., it folds, cleanly, both halves. |
| 29 | - You brought chips. Cookies are acceptable in winter. |
| 30 | |
| 31 | ## Code of conduct |
| 32 | |
| 33 | Open. Kind. And nobody takes the first bite until everyone has a plate |
| 34 | in front of them. That last piece isn't governance, it's the whole point |
| 35 | of open source applied to a table. |
open hoagie