Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Adding proper comments to all files #370

Closed
Ayushmaanagarwal1211 opened this issue Jun 27, 2024 · 1 comment
Closed

Feat: Adding proper comments to all files #370

Ayushmaanagarwal1211 opened this issue Jun 27, 2024 · 1 comment

Comments

@Ayushmaanagarwal1211
Copy link
Contributor

Describe the feature

Overview

This issue aims to improve the readability and maintainability of the codebase by adding proper comments to all files in the project. Comments should be added at various levels, including file-level, component-level, function-level, and inline comments where necessary.

Task Breakdown

  1. General Guidelines
  2. File-Level Comments
  3. Component-Level Comments
  4. Function-Level Comments
  5. Inline Comments
  6. Example Code

General Guidelines

  • Keep comments concise and relevant: Comments should be brief but informative.
  • Update comments regularly: Ensure that comments are updated to reflect any changes in the code.
  • Avoid obvious comments: Do not comment on code that is self-explanatory.

File-Level Comments

At the top of each file, add a comment describing the purpose of the file and any important information.

Example

/**
 * @file InfluencersList.js
 * @description This file contains the InfluencersList component which displays a list of influencers with filtering options.
 */

same for more

### Add ScreenShots

![Screenshot 2024-06-27 195400](https://github.com/subhadeeproy3902/BloxAI/assets/118350936/b4aded2d-5af0-4924-9e76-94523a4d1a1c)


### Record

- [X] I agree to follow this project's Code of Conduct
- [X] I'm a GSSOC'24 contributor
- [X] I want to work on this issue
@subhadeeproy3902 subhadeeproy3902 closed this as not planned Won't fix, can't repro, duplicate, stale Jul 1, 2024
Copy link

github-actions bot commented Jul 1, 2024

Hello @Ayushmaanagarwal1211! Your issue #370 has been closed. Thank you for your contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants