pantry/README.md

71 lines
2 KiB
Markdown
Raw Normal View History

2022-08-01 22:43:40 +03:00
![tea](https://tea.xyz/banner.png)
2022-10-31 18:08:38 +03:00
This pantry† represents the most essential open source packages in the world.
We promise to prioritize fixes, updates and robustness for these packages.
We will not lightly accept additions, and thus suggest submitting your pull
request against [pantry.extra] first.
2022-08-01 22:43:40 +03:00
2022-10-31 18:08:38 +03:00
> † see [pantry.zero] for “what is a pantry”
2022-10-31 18:08:38 +03:00
# Use with tea/cli
2023-02-11 13:52:24 +03:00
[tea/cli] clones/updates this pantry and [pantry.extra] when installed with
the installer or when you run `tea --sync`. At this time pantries are not
2022-11-07 18:33:11 +03:00
versioned.
2022-08-01 22:43:40 +03:00
2023-02-11 13:52:24 +03:00
 
2022-10-31 18:08:38 +03:00
# Contributing
2022-08-01 22:43:40 +03:00
2023-02-11 13:52:24 +03:00
```sh
$ git clone https://github.com/teaxyz/pantry.core
$ cd pantry.core
# all the following commands operate in `./tea.out`
# your tea installation remains untouched
2023-02-12 19:56:04 +03:00
$ pkg init
2023-02-11 13:52:24 +03:00
# ^^ creates a “wip” package.yml
2023-02-12 19:56:04 +03:00
$ pkg edit
2023-02-11 13:52:24 +03:00
# ^^ opens the new package.yml in your EDITOR
2023-02-12 19:56:04 +03:00
$ pkg build
2023-02-11 13:52:24 +03:00
# ^^ will probably require a (zero permissions) GitHub [PAT].
# Using `gh auth login` is the easiest way to set this up.
2023-02-12 19:56:04 +03:00
$ pkg test
2023-02-11 13:52:24 +03:00
# ^^ you need to write a test that verifies the package works
$ gh repo fork
$ git branch -m my-new-package
$ git push origin my-new-package
$ gh pr create
```
## Packaging Guide
Packaging can be cumbersome.
Our [wiki] is our packaging knowledge base.
For other assistance, start a [discussion].
## After Your Contribution
We build “bottles” (tard binaries) and upload them to both our centralized
bottle storage and decentralized [IPFS].
tea automatically builds new releases of packages *as soon as they are
released* (usually starting the builds within seconds). There is no need to
submit PRs for updates.
2022-08-01 22:43:40 +03:00
2023-02-11 13:52:24 +03:00
[pantry.zero]: https://github.com/teaxyz/pantry.zero
2022-11-18 19:13:15 +03:00
[pantry.extra]: https://github.com/teaxyz/pantry.extra
2023-02-11 13:52:24 +03:00
[wiki]: https://github.com/teaxyz/pantry.zero/wiki
[tea/cli]: https://github.com/teaxyz/cli
[discussion]: https://github.com/orgs/teaxyz/discussions
[PAT]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
[IPFS]: https://ipfs.tech