LogoLogo
10.0.x
10.0.x
  • Overview
    • About Varbase
    • Roadmap
    • Release Cycle and Supported Versions
    • How to Get Support
  • Developers
    • Getting Started
    • Installing Varbase
      • Requirements
      • Installing Varbase locally with DDEV
      • Installing Varbase locally with Lando
    • Understanding Varbase
      • Basic Concepts
      • Core Components
        • Varbase Core
          • Varbase Admin
          • Varbase Page
          • Varbase Security
          • Varbase Webform
          • Varbase Default Content
          • Varbase Tour
        • Varbase Media
        • Varbase Editor
        • Varbase Email
        • Varbase SEO
        • Varbase Workflow
        • Varbase Dashboards
        • Varbase Layout Builder
          • Varbase Landing page (Layout Builder)
          • Varbase Heading Block
          • Varbase Rich Text Block
          • Varbase HTML Code Block
          • Varbase Media (Image/Video) Block
          • Varbase Gallery Block
        • Varbase Components
        • Vartheme Claro
        • Vartheme BS5
      • Optional Components
        • Varbase AI
          • Varbase AI Default recipe
          • Varbase AI Editor Assistant recipe
          • Varbase AI Image Alt recipe
          • Varbase AI Taxonomy Tagging recipe
          • Varbase AI Agents recipe
        • Varbase API
        • Varbase Internationalization
        • Varbase Hero Slider
        • Varbase Carousels
        • Varbase Blog
        • Varbase Search
        • Varbase Social Single Sign-On
        • Varbase Media Twitter
        • Varbase Media Instagram
        • Varbase Content Planner
        • Varbase Bootstrap Paragraphs
          • Varbase Bootstrap Paragraphs Text and Image
        • Varbase Landing Page (Paragraphs)
      • Additional Components
        • Varbase Media Header
        • Varbase FAQs
        • Varbase Reports
        • Varbase Commerce
        • Varbase YouTube Import
      • Development Components
        • Varbase Development
        • Reroute Email
        • Varbase Updates Helper
      • Deprecated Components
        • Varbase Media Hero Slider
        • Varbase Style Guide
        • Vartheme BS4
        • Varbase Total Control Dashboard
    • Configuring a Varbase Site
      • Navigation
        • Defining Active Menu Trail Using Menu Position
      • Using View Modes Inventory
      • Content Moderation and Workflows
      • URL Aliases in Varbase/Drupal
        • Configuring URL Aliases
        • Managing URL Aliases
      • Managing URL Patterns for Multilingual Websites
      • Managing Date and Time Formats to Display Across the Site
      • Using Varbase Layout Builder
        • Creating a Landing Page With Varbase Layout Builder
        • Activating Varbase Layout Builder for Content Types
      • Configuring Pathologic When Going Live
      • Configuring SEO Features
        • Disallow Oembed Media Links
      • Configuring Security Features
        • Spam Protection
        • Password Policies
        • Other Security Kits
        • Flood Contorl
        • Enable HTTP Password Authentication
      • Configuring JSON:API Features
      • Configure Varbase Media Hero Slider
      • Configuring Varbase Media Header
      • Configuring Varbase Mailer Settings
        • Configure Symfony Mailer
      • Configure Level of Logging and Errors
      • Entity Definition Update Manager Class
      • Module Installer Factory Class
      • Configure Ckeditor 5 Media Embed
    • Theme Development with Varbase
      • Understanding The Vartheme Starterkit Theme
      • Creating Your Own Theme
      • Integration of Varbase with Storybook 1.0 - CL Server
      • Integration of Varbase with Storybook 2.0
      • Customize a Varbase Single Directory Components (SDC) In a Custom Theme
      • Local Tasks and Moderation Sidebar
      • Add Preloaded Fonts in Vartheme
      • Command to Install Needed Theming Tools
      • Manually Install Needed Theming Tools
    • Launching a Varbase Site to Production
    • Updating a Varbase Site
      • Understanding Varbase Updater Package
      • Handling Patches When Updating
      • Handling Configuration Updates
      • Updating Varbase to work with Composer 2.0
      • Updating Drush to the Latest Stable Version
      • Version Update Guides
        • Updating Varbase ~9.0 to Drupal 10
        • Updating from Varbase 8.x to 9.x
    • Varbase Patches
    • Frequently Asked Questions (FAQs)
    • Extending Varbase
      • Overriding Varbase
      • Creating Your Own Feature
      • Install Needed YARN and Webpack Tools
      • Compiling Provided Component Styles
      • Check Standards/Practice Coding And Linting
  • Content Designers
    • Accessing the Administration Area
      • Website Environments
    • Dashboard
      • Reports
    • Content Management
      • Create Content
        • Rich-Text Editor “WYSIWYG”
      • Modify Content
      • Delete Content
      • Preview Content
      • Bulk Edit Content
      • Publish Content
      • Authoring Information
    • Content Structure
      • EntityQueues
        • Add a New Term
      • Menu Management
        • Add Menu Items
        • Update Menu Items
        • Adding a Page to the Menu
      • Taxonomies
        • List Terms
        • Add Terms
        • Reorder and Edit Terms
    • Content Translation
      • Translating Content
      • Language Switcher
      • Deleting a Translation
      • Editing a Translation
    • Content Workflow
    • Layout Builder
      • Section
        • Section Styles
      • Block Management
        • Block Styles
      • Reordering Blocks
    • Webforms
      • Create New Webform View
      • Setting up Emails Handler Conditions
      • Setting up Confirmations Message Settings Types
    • Media Management
      • Accessing the Media Library
      • Uploading Media Files
        • Image
        • Remote Video
        • Video
      • Applying Metadata and Descriptions
      • Resizing Images
    • User Management
      • Login & Registration
      • Add User
      • Edit User
      • Delete User
      • Simulating Another User
      • Default Roles and Site Personas
        • Edit Roles' Permissions
        • Managing Roles
    • URL Management
      • URL Aliases
      • Generating URL Alias
      • URL Redirects
      • Domain Redirects
    • SEO Management
      • XML Sitemap
      • Meta Tags in Varbase
      • Disallow Indexing for Content Items
    • Site Configuration
      • System
        • Clearing Varbase Cache
        • Google Analytics
        • Mail Templates
      • User Interface
        • Coffee
        • External Links
        • Gin Moderation Sidebar
        • Layout Builder Modal
        • Moderation Sidebar
        • Shortcuts
        • Taxonomy Manager
        • Tours
        • CL Components
        • Antibot
        • Responsive Preview
        • Navigation Settings
      • Development
      • Varbase Settings
      • Web Services
        • OpenAPI
    • Additional Tips
      • Content Uploading Standards
      • Common Error Handling Tips
      • Glossary
  • Contributing
    • Contributing to Documentation
Powered by GitBook
On this page
  • How You Can Help
  • Contributing New Features or Components
  • Help in Development
  • Create Patches or Pull Requests
  • Keep Conventions in Mind
  • Keep Your Branch Up to Date
  • Create Functional Behat Tests

Contributing

Want to contribute to Varbase? Here are ways you can help!

PreviousGlossaryNextContributing to Documentation

Last updated 4 months ago

How You Can Help

Varbase is a Drupal distribution packed with adaptive functionalities and essential modules, that speed up your development, and provide you with standardized configurations, making your life easier.

It helps you build sites that employ enterprise-editing experience with a lot of functionalities.

We would love for you to join us in the effort of building Varbase. We are welcoming your feedback, (development) time and/or financial support. For feedback we will use for other questions or suggestions please contact us at

You can also join our Varbase Slack team for feedback and support

Visit to join now.

Contributing New Features or Components

We're very excited to have you interested in contributing features to Varbase. Contributing to Varbase new modules, features, or components should be an easy process if you are familiar with Drupal. We just require the following guidelines to be taken into consideration when contributing new modules, features, or components:

  1. The feature idea should be validated with Varbase maintainers. Please submit a new issue on as a "Feature request" to confirm its validity before starting to work on it. This is of course if you would like this feature to be included in the Varbase roadmap

  2. The feature must follow the friendly User Experience guidelines according to Vardot's standards.

    See

  3. Proper coding standards must be followed according to Vardot's agreed-upon coding standards. This applies to all code elements (PHP, CSS, JS, Twig ...etc.)

  4. Considers all the Site Building config such as Permissions, Config, View modes, Form modes, Integrations

  5. Tested frontend utilizing Bootstrap 4 and/or 5

Help in Development

  • ✅ File an issue about Varbase components.

  • ✅ Manage to have Addition/Change/Update/Fix to Varbase components.

  • ✅ Help with testing to ensure no regression.

  • ✅ Help with Automated unit/functional testing coverage.

  • ✅ Help with developer documentation support on feature change/addition.

  • ✅ Help with user guide documentation support on feature change/addition.

  • ✅ Help with update Release Notes and Update Helper on new feature change/addition.

  • ✅ Help in code review with Varbase core team members.

  • ✅ Help with full testing and approval.

  • ✅ Help credit contributors.

  • ✅ Help review with the product owner.

  • ✅ Help with pre-release and post-release testing.

Reporting issues and patching is welcomed with a smile and thank you, and they will be credited for sure. And highly appreciated on:

  • ✅ Accessibility.

  • ✅ Performance.

  • ✅ Security.

Create Patches or Pull Requests

Keep Conventions in Mind

Keep Your Branch Up to Date

Have a rebase for the used issue fork, or git pull and merge or rebase locally, before committing to an issue fork. Or before creating a patch file.

Create Functional Behat Tests

Recommended using the issue fork contribution workflow.

Recommended following with and .

Compiling Provided Component Styles
Check Standards/Practice Coding And Linting
Creating issue forks and merge requests
Drupal coding standard
naming conventions
Varbase Automated Functional Testing
drupal.org's issue queue
varbase@vardot.com
http://slack.varbase.vardot.com/
https://www.drupal.org/node/add/project-issue/varbase
https://www.drupal.org/docs/develop/user-interface-standards
Install Needed YARN and Webpack Tools