Add Pre-commit Hooks and Documentation to Development Environment

[KesharwaniArpita]

Contributor checklist

• This pull request is on a separate branch and not the main branch
• I have tested my code with the ./gradlew lintKotlin detekt test command as directed in the testing section of the contributing guide

---

Description

This PR adds pre-commit hooks and related documentation regarding the setup and usage of pre-commit hooks to ensure a cleaner, more consistent codebase for Scribe-Android. The pre-commit hooks will help contributors automatically check for code quality issues, such as trailing whitespaces, missing newlines, and linting errors, before committing their changes.

Changes Introduced:

• Added Pre-Commit hooks.
• Added a new section in the Development Environment documentation explaining how to set up and use pre-commit hooks.
• Included a detailed list of pre-commit hooks currently configured for Scribe-Android.
• Provided instructions for installing, configuring, and manually running the pre-commit checks.

Pre-commit Hooks Configured:

• trailing-whitespace: Removes trailing whitespaces in code.
• end-of-file-fixer: Ensures files end with a newline.
• ruff: Lints Python code for Python scripts used in the project.

Manual Command for Running Pre-commit Hooks:

pre-commit run --all-files

Testing Steps:

1. Follow the updated documentation to set up the pre-commit hooks in your local environment.
2. Make a commit and confirm that the pre-commit hooks run automatically.
3. Optionally, run the hooks manually with pre-commit run --all-files to ensure everything works as expected.

Related issue

• Add pre-commit hooks to Scribe-Android #215

[github-actions]

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Android rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

• The linting and formatting workflows within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[andrewtavis]

Thanks for this, @KesharwaniArpita!