Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 3.3 KB
Raw

Contributing to DependencyGuard

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to DependencyGuard. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct.

By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

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

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Please use the following as guidelines to write a bug report:

Please describe the found bug

A clear and concise description of what the problem is.

I'm always frustrated when [...]

Describe the solution you'd like

A clear and concise description of what you want to happen.

I would like the following changes to be made, in order to achieve [...]

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

I have considered using X with Y, yet [...]

Additional context

Add any other context or screenshots about the feature request here.

Dependency Guard: JSON format

Pull Requests

  • Do not include issue numbers in the pull request title.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • Follow the style guides in this document.
  • Add two of the following reviewers:
    • Ashoka de Wit
    • Jan-Marten de Boer
  • Ensure Scrutinizer CI runs successfully. Build Status
  • Ensure code coverage stays the same or increases. Code Coverage
  • Ensure code quality stays the same or improves. Scrutinizer Code Quality

Styleguides

PHP

The package mediact/testing-suite is installed, ensuring code style and standards, as well as quality.

To locally test using the testing suite, use the following:

vendor/bin/grumphp run

This will run GrumPHP using the tests set by the testing suite.

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