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

Improvements of examples and additional "Howto" guides #1

Open
mlange05 opened this issue Nov 10, 2023 · 0 comments
Open

Improvements of examples and additional "Howto" guides #1

mlange05 opened this issue Nov 10, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@mlange05
Copy link
Collaborator

Note: This long-standing issue is meant to facilitate an ongoing discussion about ways in which to improve aspects of this document.

While one of the key points of this document is to enshrine the underlying rules that may be used for automated code checking and guided refactoring, it is important to make this document not only prohibitive, but also provide guidance and examples on how to write "good code". These need not be tied to individual rules, but suggestions might include overarching changes, like refactoring of the document, or addition of specific "Howto guides". The intention for this issue is the discuss such suggestions before embarking on large-scale restructuring or implementation efforts.

@mlange05 mlange05 added the enhancement New feature or request label Nov 10, 2023
@mlange05 mlange05 changed the title Improvements of example and additional "Howto" guides Improvements of examples and additional "Howto" guides Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant