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.

Sign up for GitHub

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

Jump to bottom

Add Coding Patterns and Guidelines Documentation #2318

Merged
merged 3 commits into from
Dec 23, 2024
Merged

Add Coding Patterns and Guidelines Documentation #2318

merged 3 commits into from
Dec 23, 2024

Conversation

itsmdasifraza
Copy link
Member

@itsmdasifraza itsmdasifraza commented Dec 23, 2024 •
edited
Loading

Description

This PR introduces a comprehensive Coding Patterns and Guidelines document to ensure consistency, readability, and maintainability across the codebase.

Key Highlights:

  • Standardized naming conventions for variables, functions, classes, and constants.
  • Emphasis on best practices, including arrow functions, destructuring, and default parameters.
  • Clear examples demonstrating preferred and non-preferred approaches.
  • Principles like Single Responsibility and avoiding magic numbers.
  • Improved error handling patterns.

Why this is important:

  • Enhances code clarity and reduces ambiguity.
  • Encourages adherence to industry best practices.
  • Serves as a reference guide for both new and existing developers.
  • Please review the document and share your feedback! 🚀

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build

Have you tested locally?

  • 👍 yes
  • 🙅 no, because I am lazy

@pratikshinde590
Copy link
Contributor

Please attach the issue link

@itsmdasifraza itsmdasifraza marked this pull request as draft December 23, 2024 07:35
@pratikshinde590
Copy link
Contributor

Please attach the issue link

@pratikshinde590
Copy link
Contributor

Please attach the issue link

@itsmdasifraza itsmdasifraza changed the title Create CODE_PATTERNS.md Add Coding Patterns and Guidelines Documentation Dec 23, 2024
@pratikshinde590
Copy link
Contributor

Please attach the issue link

@itsmdasifraza itsmdasifraza self-assigned this Dec 23, 2024
@pratikshinde590
Copy link
Contributor

Please attach the issue link

@itsmdasifraza itsmdasifraza added the documentation Improvements or additions to documentation label Dec 23, 2024
@itsmdasifraza itsmdasifraza marked this pull request as ready for review December 23, 2024 08:17
@Astitva877 Astitva877 merged commit 26589a6 into sparrowapp-dev:development Dec 23, 2024
0 of 12 checks passed
@pratikshinde590
Copy link
Contributor

🎉 This PR is included in version 2.15.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Astitva877 Astitva877 Astitva877 approved these changes

@gc-codes gc-codes Awaiting requested review from gc-codes gc-codes is a code owner

Assignees

@itsmdasifraza itsmdasifraza

Labels
documentation Improvements or additions to documentation released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@itsmdasifraza @pratikshinde590 @Astitva877