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

Research pages about rules #495

Open
maxitg opened this issue Oct 26, 2020 · 0 comments
Open

Research pages about rules #495

maxitg opened this issue Oct 26, 2020 · 0 comments
Labels
english Changes to the English text, but no coding feature New functionality, or change in existing functionality infrastructure Has to do with changes to the development process, e.g., build scripts, CI, testing utilities

Comments

@maxitg
Copy link
Owner

maxitg commented Oct 26, 2020

The problem

Some of the research pages will investigate the properties of a particular rule. We need a special directory for such pages together with an index where the rules will be arranged by categories, etc..

Possible solution

Create Research/Rules directory with a README.md file in it describing how the rules directory works, and how to create new pages in a consistent way.

Alternative solutions

It would certainly be nice to have a (more stable) version of the rule registry, but that's a lot of work, and I don't think this should be the primary focus. Instead, we should focus on manually explaining why a particular rule is interesting.

@maxitg maxitg added feature New functionality, or change in existing functionality infrastructure Has to do with changes to the development process, e.g., build scripts, CI, testing utilities english Changes to the English text, but no coding labels Oct 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
english Changes to the English text, but no coding feature New functionality, or change in existing functionality infrastructure Has to do with changes to the development process, e.g., build scripts, CI, testing utilities
Projects
None yet
Development

No branches or pull requests

1 participant