chocolatey / docs

https://docs.chocolatey.org - new docs website
Apache License 2.0
156 stars 176 forks source link

(ENGTASKS-3807) (doc) Add documentation of new rule CPMR0075 #1030

Closed AdmiringWorm closed 3 months ago

AdmiringWorm commented 3 months ago

Description Of Changes

We are planning to implement a new requirement rule for blacklisting URLs that come from GitHub comments. As this is a new rule without any associated documentation, we need to create the documentation that is related to this rule.

Motivation and Context

New rules should be fully documented.

Testing

Change Types Made

~ [ ] Minor documentation fix (typos etc.).~ ~ [ ] Major documentation change (refactoring, reformatting or adding documentation to existing page).~

Change Checklist

~ [ ] Requires a change to menu structure (top or left-hand side)/~ ~ [ ] Menu structure has been updated~

Related Issue

N/A

pauby commented 3 months ago

LGTM! Thanks for adding this @AdmiringWorm.

gep13 commented 3 months ago

Just a quick question on this....

Is it worth showing an example of a GitHub comment URL, so that it is clear what is being picked up on?

pauby commented 3 months ago

I think that would be a good addition.

AdmiringWorm commented 3 months ago

I have created the PR https://github.com/chocolatey/docs/pull/1032 to include that information.