Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (66 loc) · 4.03 KB

CONTRIBUTING.md

File metadata and controls

90 lines (66 loc) · 4.03 KB

Contributing to WarvilPHP

Thank you for considering contributing to WarvilPHP! This document outlines the guidelines for contributing to the WarvilPHP framework.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please read it before contributing.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for WarvilPHP. Following these guidelines helps maintainers understand your report, reproduce the behavior, and find related reports.

Before creating bug reports, please check the issue tracker as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title for the issue
  • Describe the exact steps to reproduce the problem in as many details as possible
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior
  • Explain which behavior you expected to see instead and why
  • Include screenshots or GIFs showing the problem
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for WarvilPHP, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title for the issue
  • Provide a step-by-step description of the suggested enhancement in as many details as possible
  • Provide specific examples to demonstrate the steps
  • Describe the current behavior and explain which behavior you expected to see instead and why
  • Explain why this enhancement would be useful to most WarvilPHP users

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Follow the PHP PSR-12 Coding Standard
  • Include appropriate test cases
  • Document new code based on the rest of the framework
  • End all files with a newline

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line
  • When only changing documentation, include [ci skip] in the commit title
  • Consider starting the commit message with an applicable emoji:
    • 🎨 :art: when improving the format/structure of the code
    • 🐎 :racehorse: when improving performance
    • 🚱 :non-potable_water: when plugging memory leaks
    • 📝 :memo: when writing docs
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • 👕 :shirt: when removing linter warnings

PHP Styleguide

All PHP code must adhere to PSR-12.

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

Type of Issue and Issue State

Label name Description
bug Confirmed bugs or reports likely to be bugs
enhancement Feature requests
documentation Documentation improvements
help-wanted The core team would appreciate help from the community in resolving these issues
question Questions more than bug reports or feature requests
duplicate Issues which are duplicates of other issues
invalid Issues which aren't valid (e.g. user errors)
wontfix The core team has decided not to fix these issues for now

Thank you for contributing to WarvilPHP!