Skip to content

manvil95/BestPracticeExtensionSF

Repository files navigation

App logo SF Best Practices Browser Extension

Important

A browser extension designed to help Salesforce developers and teams follow best practices and naming conventions. Organized into intuitive tabs, this tool provides quick access to guidelines, examples, and strategies for maintaining high-quality and maintainable Salesforce projects.

✨ Features

  • 📦 Objects & Related Metadata
    Naming conventions and best practices for Salesforce objects, fields, relationships, and related metadata with dynamic {BU} placeholder support.

  • 📄 Metadata
    Guidelines for naming and organizing custom metadata types, labels, and other metadata components.

  • ⚙️ Apex & LWC
    Best practices for writing Apex classes, triggers, and Lightning Web Components (LWC), including naming conventions and code examples.

  • 🌿 Branching Strategies
    Recommended branching strategies for version control in Salesforce projects, including Git workflows and deployment tips.

  • 💡 BU Replacement System
    Dynamic replacement of placeholder text with user-specified business unit identifier.

🎨 Dynamic UI Behaviors

The extension implements several dynamic UI behaviors to enhance the user experience:

  1. Scroll-Based Navigation Changes
    The main navigation bar fades out when scrolling down, replaced by a compact hamburger menu
  2. Back-to-Top Button
    Appears when scrolling down to provide easy navigation back to the top
  3. Business Unit Replacement
    Dynamically replaces {{BU}} placeholders with user-provided values

🌐 Browser Compatibility

Note

This extension has been primarily developed and tested for Chromium-based browsers (Edge/Chrome).

Browser Compatibility Status
Microsoft Edge ✅ Fully supported (latest version)
Google Chrome ✅ Fully supported (latest version)
Firefox ⚠️ Not officially supported
Safari ⚠️Not officially supported
Opera ⚠️ Not officially supported
Other non-Chromium browsers ⚠️ Not officially supported

🚀 Installation

  1. Clone this repository or download the extension files.
  2. Open your browser's extension management page:
    • Chrome: chrome://extensions/
    • Edge: edge://extensions/
  3. Enable Developer mode.
  4. Click Load unpacked and select the extension folder.
  5. The extension will appear in your browser's toolbar.

🛠️ Usage

Core Functionality:

  • Click the extension icon in your browser's toolbar to open the popup.
  • Navigate through the tabs to access the relevant best practices and naming conventions.
  • Business Unit (BU) placeholder automatically propagates
  • Use the examples and guidelines to improve your Salesforce development workflow.

📸 Screenshots

Main Tab
Business Business Text Menu

🤝 Contributing

We welcome contributions! If you have suggestions for additional best practices, naming conventions, or improvements, please:

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b feature/YourFeatureName
  3. Commit your changes:

    git commit -m 'Add some feature'
  4. Push to the branch:

    git push origin feature/YourFeatureName
  5. Open a pull request.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

📞 Contact

For questions or feedback, feel free to:


🎉 Thank you for using SF Best Practices Browser Extension! 🎉


Contributor Covenant

About

A browser extension that centralizes best practices and recommended naming conventions for Salesforce development.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks