You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, the development documentation in DEVELOPING.md and the "Writing a Custom Rule" section in README.md is outdated since we introduced the ConfigurableRule interface in #1185. Additionally, the information is slightly duplicated between documents.
What I propose
Move everything from "Writing a Custom Rule" to DEVELOPING.md. Add a link in the README that says "See DEVELOPING.md for instructions on how to write a custom rule."
Remove make install from DEVELOPING.md.
Extend DEVELOPING.md with a section about configurable rules and the ConfigurableRule interface.
Add a link to DEVELOPING.md in CONTRIBUTING.md.
The text was updated successfully, but these errors were encountered:
Currently, the development documentation in
DEVELOPING.md
and the "Writing a Custom Rule" section inREADME.md
is outdated since we introduced theConfigurableRule
interface in #1185. Additionally, the information is slightly duplicated between documents.What I propose
DEVELOPING.md
. Add a link in the README that says "SeeDEVELOPING.md
for instructions on how to write a custom rule."make install
fromDEVELOPING.md
.DEVELOPING.md
with a section about configurable rules and theConfigurableRule
interface.DEVELOPING.md
inCONTRIBUTING.md
.The text was updated successfully, but these errors were encountered: