Skip to content

Valourite/CenterThis

Repository files navigation

Contributing to Valourite Projects

Thank you for your interest in contributing to Valourite! We’re building a collection of high-quality open-source packages and modular applications — from Laravel and Filament plugins to Flutter apps and DevOps tools. Your help keeps these projects growing and improving.

This guide explains how you can contribute to any Valourite project — whether you’re reporting a bug, improving code, enhancing documentation, or helping others.


Table of Contents

  1. How Can I Contribute?

  2. Development Guidelines

  3. Getting Started with Development

  4. Community and Support

  5. Code of Conduct


How Can I Contribute?

Reporting Bugs

If you find a bug in any Valourite project, please open an issue in that project’s repository and include:

  • Description: What happened, and what you expected to happen.
  • Steps to Reproduce: A clear list of steps.
  • Screenshots or Logs: If applicable.
  • Environment: OS, PHP or Flutter version, browser, or tool versions.

👉 Each repository has its own Issues tab for reporting problems (e.g., Valourite/Dynamic-Models).


Suggesting Features

Have an idea? We’d love to hear it.

When creating a feature request, include:

  • What problem it solves.
  • How it would improve the project.
  • Any examples or mockups if relevant.

Use the “Feature Request” issue template if the repository provides one.


Code Contributions

We follow a simple fork-and-pull workflow:

  1. Fork the repository on GitHub.

  2. Clone your fork:

    git clone https://github.com/your-username/repo-name.git
    cd repo-name
  3. Create a feature branch:

    git checkout -b feature/your-feature-name
  4. Make and test your changes.

  5. Commit and push:

    git commit -m "Add: short description of feature"
    git push origin feature/your-feature-name
  6. Open a Pull Request to the main repository.

💡 Before submitting a PR, ensure your changes follow the coding standards and include any relevant documentation or tests.


Documentation

Contributing to documentation is just as valuable as code.

You can:

  • Fix typos or grammar.
  • Add missing instructions.
  • Write or update technical guides.

Edit Markdown files directly in the repository (/docs or root .md files) and open a pull request.


Translations

Some Valourite projects include multilingual support. If your language isn’t yet supported — or translations need improvement — we’d love your help!

See each project’s TRANSLATIONS.md or lang/ folder for details.


Community Support

Join the community to help others and share ideas:

  • Discord Community — To Be Announced
  • GitHub Discussions / Issues — Participate in design and feedback.
  • Contribute Examples or Demos — Share code samples, bug reproductions, or UI ideas.

Development Guidelines

Coding Standards

Consistency matters across all Valourite repositories.

Language Standard
PHP PSR-12 + Laravel conventions
JavaScript / TypeScript ESLint (Standard/Prettier)
Dart (Flutter) Dart Style Guide
Markdown / Docs Simple and concise English

Branching Strategy

  • main → Stable releases
  • develop → Active development
  • feature/* → New features
  • bugfix/* → Fixes
  • hotfix/* → Urgent production fixes

Commit Messages

Use clear, conventional commits when possible:

feat: add support for dynamic form fields
fix: resolve null reference in expense seeder
docs: update README with installation steps

Getting Started with Development

Each Valourite project may differ slightly, but most Laravel-based packages follow:

git clone https://github.com/Valourite/ExamplePackage.git
cd ExamplePackage
composer install
cp .env.example .env
php artisan key:generate
php artisan serve

For Flutter projects:

flutter pub get
flutter run

See the repository’s README.md for setup instructions specific to that project.


Community and Support


Code of Conduct

We’re committed to maintaining a welcoming, respectful, and inclusive environment for all contributors.

By participating in any Valourite project, you agree to uphold the Code of Conduct.


Together, we’re building something powerful. Welcome to Valourite — let’s create with purpose.


About

Official CenterThis website built in laravel, using livewire

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors