Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define and apply standard formatting #289

Open
2 tasks
Larocceau opened this issue Oct 4, 2023 · 0 comments
Open
2 tasks

Define and apply standard formatting #289

Larocceau opened this issue Oct 4, 2023 · 0 comments

Comments

@Larocceau
Copy link
Contributor

Larocceau commented Oct 4, 2023

While trying to find an example for writing a new recipe, I came across a few different formats for recipes.

  • Some recipes include a H1 title, some don't
  • some recipes include a short introduction, some don't
  • Some skip certain header sizes
  • Some templates include code diffs, most don't

I'd also say it would be a good idea to include the version of the template the recipe was tested on as a standard element of the recipe

Proposed actions:

  • Determine a standard for layouts, and document this in contributing.md
  • apply the defined layout to existing templates
@Larocceau Larocceau changed the title Determine apply standard formatting Define and apply standard formatting Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant