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

Improve developing documentation #1194

Open
alexandear opened this issue Dec 23, 2024 · 0 comments
Open

Improve developing documentation #1194

alexandear opened this issue Dec 23, 2024 · 0 comments

Comments

@alexandear
Copy link
Contributor

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

  1. 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."
  2. Remove make install from DEVELOPING.md.
  3. Extend DEVELOPING.md with a section about configurable rules and the ConfigurableRule interface.
  4. Add a link to DEVELOPING.md in CONTRIBUTING.md.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants