Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Improve developing documentation #1194

Closed
alexandear opened this issue Dec 23, 2024 · 2 comments
Closed

Improve developing documentation #1194

alexandear opened this issue Dec 23, 2024 · 2 comments
Labels
good first issue

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.
@mfederowicz mfederowicz mentioned this issue Jan 22, 2025
Merged
4 tasks
@mfederowicz
Copy link
Contributor

@alexandear for me this issue is to close :)

@alexandear
Copy link
Contributor Author

Closed by #1203

In the future, please use Fixes #ISSUE_NUMBER in PR's description, so the GitHub closes the issue automatically.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@alexandear @chavacava @mfederowicz