Add instructions for rendering

Signed-off-by: Nicholas Wilde <ncwilde43@gmail.com>
This commit is contained in:
Nicholas Wilde 2022-05-14 02:02:58 +00:00
parent b6047a10d2
commit eb4798f72d
No known key found for this signature in database
GPG Key ID: F08AD0AD08B7D7A3

View File

@ -12,8 +12,43 @@ project you agree to abide by its terms.
Ensure your pull request adheres to the following guidelines:
1. Fork this repository.
2. Add your awesome cooklang recipes link to the [README.md](../README.md).
3. Submit a [pull request][3].
2. Add your awesome cooklang recipes link to [data.yaml](../data.yaml).
```yaml
...
- description: "Description of your cookbook."
website:
name: "Name of your website"
url: "Url of your website"
cooklang:
name: "Name of your your cookbook site with all of your *.cook files."
url: "Url of your cookbook"
user:
name: "Your user name"
url: "Link to your website or profile."
...
```
3. Install dependencies
```shell
pip install -r ./scripts/requirements.txt
```
4. Render a new `README.md`.
```shell
python scripts/render_readme.py > README.md
```
5. Lint the repo using [awesome-lint][4] and [yamllint][5]
```shell
npx awesome-lint
yamllint .
```
6. Submit a [pull request][3].
Thank you for your suggestions!
@ -32,3 +67,5 @@ on the different ways you can update your PR so that we can merge it.
[1]: https://github.com/sindresorhus/awesome-lint
[2]: https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md
[3]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
[4]: https://github.com/sindresorhus/awesome-lint
[5]: https://github.com/adrienverge/yamllint