Skip to content

Contributing to Cubeta Starter

Thank you for considering contributing to Cubeta Starter! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

By participating in this project, you agree to abide by our code of conduct:

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on what is best for the community

How Can I Contribute?

Reporting Bugs

If you find a bug in the package, please report it by creating an issue on our GitHub repository. When filing a bug report, please include:

  1. A clear and descriptive title
  2. Steps to reproduce the issue
  3. Expected behavior
  4. Actual behavior
  5. Screenshots (if applicable)
  6. Your environment details:
    • Laravel version
    • PHP version
    • Cubeta Starter version
    • Operating system

Suggesting Enhancements

We welcome suggestions for improving Cubeta Starter. To suggest an enhancement:

  1. Create an issue on our GitHub repository
  2. Use a clear and descriptive title
  3. Provide a detailed description of the suggested enhancement
  4. Explain why this enhancement would be useful to most Cubeta Starter users
  5. Include any relevant examples or mockups

Pull Requests

We actively welcome pull requests:

  1. Fork the repository
  2. Create a new branch for your feature or bugfix
  3. Make your changes
  4. Submit a pull request

Pull Request Guidelines

  • Follow the PSR-12 coding standards
  • Write clear, descriptive commit messages
  • Update documentation to reflect your changes
  • Keep pull requests focused on a single change

Development Setup

To set up Cubeta Starter for local development:

  1. Fork and clone the repository
  2. Install dependencies:
    bash
    composer install
    # then
    npm install

Documentation

If your changes require documentation updates, please include them in your pull request. Documentation is written in Markdown and located in the /docs directory.

Versioning

We follow Semantic Versioning. When contributing, please be mindful of how your changes might affect the version number:

  • Bug fixes and minor changes increment the patch version (1.0.x)
  • New features that don't break backward compatibility increment the minor version (1.x.0)
  • Breaking changes increment the major version (x.0.0)

Release Process

Our release process follows these steps:

  1. Update the changelog with all notable changes
  2. Update version numbers in relevant files
  3. Create a new release on GitHub
  4. Publish the new version to Packagist

Questions?

If you have any questions about contributing, please feel free to ask by creating an issue on our GitHub repository.

Thank you for contributing to Cubeta Starter!

Released under the MIT License.