Post Implement Custom Lint work

[literalEval]

Bugs

• Get flutter pub get to run inside talawa_lint
• Upgrade or remove explicitly mentioned Dart version in push.yaml (Remove only if it can be proved that explicit definition is not doing anything special)

Core Implementation

• Add ignore directive corresponding to our new custom lint rules at the beginning of each file.
• Add a script that will check for the presence of our ignore directive in entirety of a file and
  • Pass if ignore directive is not found anywhere
  • Fail otherwise
• Add flutter pub run custom_lint in the workflow so that our custom lint rules are actually checked for during pull request and push.

[literalEval]

@palisadoes

I am able to check our custom lint rules in the workflow 🎊

[palisadoes]

• This is good news, steady progress.
• Where are you planning on documenting this? We may need a separate style guide external to contributing.md and link between the two.

[literalEval]

Yeah. I believe we should add it's documentation in our docs site and refer to it in Contributing.md

[palisadoes]

@literalEval What's the progress on this an the related open issues?

[literalEval]

Will try to create a new PR till night @palisadoes . Sorry, was busy travelling.

[palisadoes]

Happy Holi!

[literalEval]

Same to you @palisadoes 🎊 🎊 :)

[literalEval]

@palisadoes can you please stop merging new PRs from now on till I get the Add ignore statement to files task of this issue merged ? Reason for this being that all of the dart files will be modified and may cause merge conflicts.
I will open the respective PR after your confirmation. Thanks.

[palisadoes]

OK

[palisadoes]

@anwersayeed @tasneemkoushar This issue is nearing completion for forcing contributors to have valid DartDoc comments when submitting PRs. Please take a final look on #1479 to make sure that the formatting proposed in compatible with DartDoc.

• Create a documentation comment linter that is compatible with DartDoc #1479
• Adding some custom lint rules to Talawa #1550

This will hopefully improve the quality of our code over time.