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

Editing Guidelines for Spec writers #980

Open
egekorkan opened this issue Aug 9, 2021 · 0 comments
Open

Editing Guidelines for Spec writers #980

egekorkan opened this issue Aug 9, 2021 · 0 comments
Labels

Comments

@egekorkan
Copy link
Contributor

When writing a specification document, there aren't guidelines I am aware of regarding how the source files (HTML or other similar ones) should be formatted. It would be nice to have some rules on tab or space and maximum line width before going to a new line. Without such rules, each source document looks different and making it difficult (or annoying) to keep following rules that someone has set at some point.

I would propose an editorconfig file (https://editorconfig.org/) for each repository, which should be ideally respected across all source files. This would result in a PR with a lot diffs but ideally the final rendered file should show no errors.

P.S.: I have looked at TD, Binding Templates, Architecture and Scripting API and couldn't find this information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants