revanced-patches-template icon indicating copy to clipboard operation
revanced-patches-template copied to clipboard

fix: use consistent patch descriptions

Open xafn opened this issue 2 years ago • 0 comments

Type

Cosmetic

Bug description

Patches have an inconsistent writing style of descriptions.

Some issues I have observed:

  1. Some patch descriptions include the name of the targeted app, while other patches for it do not.
  2. Related patches for different applications have slightly different descriptions, when they should all be consistent. https://user-images.githubusercontent.com/47723802/232953871-dfb06072-3a4b-4a12-8bce-7e3f022a11ed.png
  3. Some patches have plain grammar/spelling mistakes. https://user-images.githubusercontent.com/47723802/232954212-1c6f7498-e1e7-4df1-8ad7-4dea991993f9.png

Steps to reproduce

n/a

Relevant log output

n/a

Screenshots or videos

No response

Solution

Introduce description rules to the patches documentation. This will ensure all descriptions remain consistent.

Additional context

No response

Acknowledgements

  • [X] I have searched the existing issues and this is a new and no duplicate or related to another open issue.
  • [X] I have written a short but informative title.
  • [X] I filled out all of the requested information in this issue properly.

xafn avatar Apr 19 '23 02:04 xafn