Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 3.73 KB

Contributing to coffee-cup

First of all, thank you for your interest into this coffee cup promotional code. We just thought it was fun to have it on our cups and maybe you will enjoy it too.

The following is just an outline of guidelines how to make your contribution an easy, smooth experience for you. These are not rules, but they will make it easier for us to evaluate your contribution quickly and efficiently.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What is expected before I can contribute?

In order to submit an issue or to send us a pull request, we make the assumption you have forked or cloned our repository and that you have run the code with or without the tests.

Typos in our documentation could be provided as in-line edits on GitHub, no requirment do have our code on your system.

How can I contribute?

Reporting issues

If you come across a bug, a typo or a missing feature, you can report it directly at Coffee Cup Issues. When you fill out the issue, be as specific as possible explaining what kind of issue you have discovered, what operating system you used and which PHP version.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as GitHub issues.

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. Copy and paste the output of the command from your screen into the issue.
  • 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.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened

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
    • 🐧 :penguin: when fixing something on Linux
    • 🍎 :apple: when fixing something on macOS
    • 🏁 :checkered_flag: when fixing something on Windows
    • 🐛 :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