added new rule: require-description-complete-sentence#109
added new rule: require-description-complete-sentence#109dtracers wants to merge 17 commits intojscs-dev:masterfrom
Conversation
Fixed a null value being assigned in the case that documentation does not exist
The rule works! It catches every instance of this! But we do not want it on right now.
I left the regular expression with only \n because if it splits at end of input then it will have an extra empty array
The test was looking for an error when it should not have been… :/
fixed typo
Build should now work!
There was a problem hiding this comment.
it can be reversed with return, what you think?
There was a problem hiding this comment.
I was actually going to do that but then I decided against it because I am adding a new test case for next line starting with an upper case letter.
If more cases are added someone might put another case after the return and then it may not run if it has nothing to do with the documentation ending with a period.
|
Nice work here ;-) Thanks! What you think about this rules API? Should we document it? Is it comfortable for you? |
|
For what I was doing it was pretty easy because I just copied an existing rule from an existing pull request. If I had not done that I would have been pretty lost. But I did not actually go and look for documentation of it. I think in your documentation for making rules you should actually choose a pull request that shows all the parts needed for a rule. I would actually use this one: And then in this one pull request add extensive documentation of what each part means. And I feel that would make it easier than just a bunch of text. But that is just me! 👍 |
This is a lot more specific now in terms of requirements.
|
Changed how the rules work so it will require another review. Also build failed due to ssl error? |
|
Restarted job and it helps ;-\ I'll look into it tomorrow, thanks for you hard work here ;-) |
|
Okay thank you!
|
3 participants
Added a new rule that requires the description to be a complete sentence.
A complete sentence starts with an upper case letter and ends with a period