Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

87 lines (52 loc) · 2.96 KB

Contributing

The following is a set of guidelines for contributing to {PROJECT}, which is hosted at {PROJECT_REPO} on GitHub.

These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

  • How Can I Contribute?
    • Reporting Bugs
      • Before Submitting A Bug Report
      • How Do I Submit A (Good) Bug Report?
      • Helpful Suggestions
      • Include details about your configuration and environment:
    • Pull Requests
  • Style Guides
    • PHP
    • HTML
    • CSS
    • JS
  • Git Commit Messages

How Can I Contribute?

Reporting Bugs

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

Before Submitting A Bug Report

  • Check the FAQs in the README for a list of common questions and problems. packages)**.
  • Perform a cursory search to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues. Create an issue on the {PROJECT} repository and provide the following information.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.

  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.

  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.

  • 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.

Helpful Suggestions

  • Include screenshots and animated GIFs

Include details about your configuration and environment:

  • Which version are you using?
  • What's the name and version of the OS you're using?

Pull Requests

Describe the expectations of submitting pull requests

Style Guides

  • PHP Style Guide
  • HTML Style Guide
  • CSS Style Guide
  • JavaScript Style Guide

Git Commit Messages

  • Separate subject from body with a blank line
  • Limit the subject line to 50 characters
  • Capitalize the subject line
  • Do not end the subject line with a period
  • Write the subject line to sound like an authoritative command
  • Wrap the body at 72 characters
  • Use the body to explain what and why vs. how