diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..1461a80db2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# 贡献 + +## lilac + +Packages 仓库是由 lilac 构建的。 lilac 通过 lilac 相关文件,如 `lilac.yaml` 和 `lilac.py`,进行更新。它同时允许用户通过 PKGBUILD 构建仓库。 + +## PKGBUILD + +The PKGBUILD writing guide is give by [PKGBUILD page](https://wiki.archlinux.org/title/PKGBUILD) on ArchWiki, you can find different ways to write PKGBUILD developed by coding language. + +Also, you can refer to the [AUR](https://wiki.archlinux.org/title/PKGBUILD) if you are a beginner. And the [Arch Forum](https://bbs.archlinux.org/) and our [discussions](https://github.com/BioArchLinux/Packages/discussions) would be a great place to discuss the related issues. + +## `lilac.yaml` + +`lilac.yaml` is the required file for lilac. The regular [writing guide](https://archlinuxcn.github.io/lilac/) is provided by archlinuxcn. API is listed [here](https://lilac.readthedocs.io/en/latest/api.html) and Q&A is posted [here](https://wiki.archlinuxcn.org/wiki/Lilac_%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98#%E6%9B%B4%E6%96%B0_AUR) by wiki of archlinuxcn. + +For the lilac.yaml writing, please refer the [archlinuxcn repo](https://github.com/archlinuxcn/repo) and the [arch4edu repo](https://github.com/arch4edu/arch4edu). + +## `lilac.py` + +`lilac.py` is not the necessary file for lilac. The writing guide for `lilac.py` is provided by [archlinuxcn wiki](https://wiki.archlinuxcn.org/wiki/Lilac.py). + +For the lilac.py writing, please refer the [archlinuxcn repo](https://github.com/archlinuxcn/repo) and the [arch4edu repo](https://github.com/arch4edu/arch4edu).