You are right, there isn’t a way to see the full list of rules and their descriptions until users deploy it.
I wasn’t sure if I should put the whole list of rules and their description in the README file or just don’t put any.
Maybe I should take down the list in the release note until their is another way of knowing the rules and what they do?
Do you have suggestions on what would be the best thing to do here?
No need to list all the rules in the release notes. But users do need a way to know all the changes in the version. Did you work GH tickets toward this release? If so, I believe GH gives you a convenient way to package them in the release (altho I’ve never done it so I can’t list the mechanics of it). If not… then just make sure the release description in GH is comprehensive.
Thanks for the fast reply. I was not using GH tickets so I’ve changed this release to only state that there are new rules for now. I’ll dig into how GH tickets work and hopefully use it upon next release.
Instead of updating to fewer details, could you go the other way, please? If the previous list was complete, then you could even just restore it & drop the word “include”