Add documentation for code conventions/style. Closes one task of #201 Documentation work item

[BrunoHenriqueCh]

…s #201

Description

Adds a human-readable version of the project’s code style rules in doc/code-style.md, translating the existing .eslintrc.json configuration. This makes it easier for contributors to follow consistent coding conventions.

Related Issues

Issue 201 Documentation Work Items/ Code Style
#201

Checklist

• I have read and followed the project's contributing guidelines.
• I have made necessary updates to the documentation.

Summary by Sourcery

Documentation:

• Introduce docs/code-style.md summarizing the code style and best practices defined in .eslintrc.json

[vercel]

@BrunoHenriqueCh is attempting to deploy a commit to the Shakeel's projects Team on Vercel.

A member of the Team first needs to authorize it.

[sourcery-ai]

Reviewer's Guide

Introduces a comprehensive Markdown guide for the project’s ESLint-based code style rules to make conventions human-readable and accessible to contributors.

File-Level Changes

Change	Details	Files
Add human-readable code style documentation	Created new docs/code-style.md file Translated .eslintrc.json rules into descriptive sections Organized rules into categories (brace style, spacing, best practices, etc.)	docs/code-style.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Consider adding a table of contents at the top of code-style.md so readers can quickly navigate to specific rules in this long document.
• It might help to include a direct link or reference to the .eslintrc.json in the repo and note how to regenerate or sync this doc when ESLint rules change to prevent drift.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider adding a table of contents at the top of code-style.md so readers can quickly navigate to specific rules in this long document.
- It might help to include a direct link or reference to the .eslintrc.json in the repo and note how to regenerate or sync this doc when ESLint rules change to prevent drift.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[shakeelmohamed]

Hi @BrunoHenriqueCh, thanks for the PR!

Is there a better way to automate building this file? If ESLint conventions change, how do we keep this file updated?

[BrunoHenriqueCh]

Hi @BrunoHenriqueCh, thanks for the PR!

Is there a better way to automate building this file? If ESLint conventions change, how do we keep this file updated?

Good point
For now, I was thinking of keeping this file as a quick, readable summary and just adding a note that .eslintrc.json is the source of truth.
But I could also work on a small script to generate it automatically so it stays in sync with ESLint changes.
Would you prefer we go with the automated approach right away?

[shakeelmohamed]

@BrunoHenriqueCh Hi, yes please let’s find a way to automate this file. What do other projects do to document their code conventions?