Food/awesome-cooklang-recipes
1
0
Fork 0
mirror of https://github.com/cooklang/awesome-cooklang-recipes.git synced 2025-10-29 19:32:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
awesome-cooklang-recipes/.github/CONTRIBUTING.md
Kyle Huggins a37c41d54e fix(CONTRIBUTING): fix awesome-lint url ref
2023-07-24 17:07:45 -05:00

2.0 KiB
Raw Blame History

Contribution Guidelines

Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to Contribute

Ensure your pull request adheres to the following guidelines:

  1. Fork this repository.
  2. Add your awesome cooklang recipes link to data.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."
...
  1. Install dependencies
pip install -r ./scripts/requirements.txt
  1. Render a new README.md.
python scripts/render_readme.py > README.md
  1. Lint the repo using awesome-lint and yamllint
npx awesome-lint
yamllint .
  1. Submit a pull request.

Thank you for your suggestions!

Testing Changes

The README.md may be tested using awesome-lint

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.