Open subhramit opened 4 days ago
Thought: Like we have priority classifications for issues, should we have labels for PRs as well such as "non-blocking", "non-breaking", "non-urgent", "low priority", etc.?
Some reading about this tag: https://nipafx.dev/javadoc-tags-apiNote-implSpec-implNote/
Recently I learnt about
@implSpec
tags which are used to specify requirements/preconditions for methods. This helped clean the documentation of my code a bit.The tag shows up as "Implementation Requirements:" in javadoc as follows:
Mandatory checks
CHANGELOG.md
described in a way that is understandable for the average user (if change is visible to the user)~