Mentorship-backend: Integrate pre-commit

[SanketDG]

Is your feature request related to a problem? Please describe.
As a developer, I want other developers sending PRs to this project follow basic conventions used in this project

There are a couple of ways that such conventions can be enforced, but the most preferrred way is to have
pre-commit hooks that run in git before code is committed.

Describe the solution you'd like

• [ ] Research pre-commit and report what hooks can be used
• [ ] Implement those hooks
• [ ] Write Documentation

Describe alternatives you've considered

• Checking those conventions as part of CI
• Manually put instructions in README

Additional context

[BALaka-18]

Hi @SanketDG , I would like to work on this issue.

[Abjcodes]

I would like to work on this issue as a part of OSH. Can you assign me this issue? Thank You.

[SanketDG]

@BALaka-18 I have assigned you, feel free to start working on this.

[SanketDG]

This issue is open again since @BALaka-18 is assigned to some other issue

[Abjcodes]

Is it possible to assign me this issue?

[SanketDG]

@Abjcodes You are already assigned to multiple issues

[shreyagupta30]

Hi @SanketDG, can I work on this?

[bhanvimenghani]

I have previously made an auto commit hook in git. I want to work on this issue. If no one is working on this , can you please assign it to me.

[SanketDG]

@bhanvimenghani You are assigned!

can I work on this?

@shreyagupta30 You are already assigned to one issue in vms

[vj-codes]

How's the PR going? @bhanvimenghani

[bhanvimenghani]

@vj-codes Done with research and integration part. Just that should I add "Checking GitHub name and email set properly with a hook" or not as it would work only with my details.
Also this is the documentation link for any kind of suggestions ,if I am doing it as required for the project or not...

[vj-codes]

@vj-codes Done with research and integration part. Just that should I add "Checking GitHub name and email set properly with a hook" or not as it would work only with my details.
Also this is the documentation link for any kind of suggestions ,if I am doing it as required for the project or not...

@SanketDG ^^

[SanketDG]

@bhanvimenghani Great, the documentation seems extensive. We did similar things in vms so you might want to take inspiration from there.

Here's what you have to do:

• Select a pre commit framework (I personally like https://github.com/pre-commit/pre-commit)
• Install all the required basic hooks along with black, flake8, isort.
• Add documentation for these hooks and how to integrate them.

[bhanvimenghani]

@bhanvimenghani Great, the documentation seems extensive. We did similar things in vms so you might want to take inspiration from there.

Here's what you have to do:

• Select a pre commit framework (I personally like https://github.com/pre-commit/pre-commit)
• Install all the required basic hooks along with black, flake8, isort.
• Add documentation for these hooks and how to integrate them.

@SanketDG I have installed these hooks and updated the doc. can you see if there is something else required or should I make a pr?

[SanketDG]

Just make a PR @bhanvimenghani and then let's iterate from there