Skip to content
This repository was archived by the owner on Dec 22, 2025. It is now read-only.

Commit d2a5f35

Browse files
committed
Travis config and readme base
1 parent 69af686 commit d2a5f35

File tree

4 files changed

+156
-0
lines changed

4 files changed

+156
-0
lines changed

.travis.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
language: php
2+
3+
php:
4+
- '5.6'
5+
- '7.0'
6+
- '7.1'
7+
8+
install:
9+
- composer install
10+
11+
script:
12+
- phpunit

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to hellofresh/stats-php
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4+
5+
The following is a set of guidelines for contributing to `hellofresh/stats-php`,
6+
which are hosted in the [HelloFresh Organization](https://github.com/hellofresh) on GitHub.
7+
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes
8+
to this document in a pull request.
9+
10+
## Code of Conduct
11+
12+
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
13+
By participating, you are expected to uphold this code.
14+
Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
15+
16+
We accept contributions via Pull Requests on [Github](https://github.com/hellofresh/stats-php).
17+
18+
## How Can I Contribute?
19+
20+
### Reporting Bugs
21+
22+
This section guides you through submitting a bug report for `hellofresh/stats-php`. Following these guidelines helps maintainers
23+
and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related
24+
reports :mag_right:.
25+
26+
Before creating bug reports, please check if the bug was already reported before as you might find out that you don't
27+
need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report).
28+
29+
#### How Do I Submit A (Good) Bug Report?
30+
31+
Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on provide the following information.
32+
33+
Explain the problem and include additional details to help maintainers reproduce the problem:
34+
35+
* **Use a clear and descriptive title** for the issue to identify the problem.
36+
* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started `hellofresh/stats-php`,
37+
e.g. which command exactly you used in the terminal. When listing steps, **don't just say what you did, but explain how you did it**.
38+
* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
39+
If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
40+
* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
41+
* **Explain which behavior you expected to see instead and why.**
42+
43+
Include details about your configuration and environment:
44+
45+
* **Which version of `hellofresh/stats-php` are you using?**
46+
* **What's the name and version of the OS you're using**?
47+
48+
### Your First Code Contribution
49+
50+
Unsure where to begin contributing to `hellofresh/stats-php`? You can start by looking through these `beginner` and `help-wanted` issues:
51+
52+
* [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
53+
* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
54+
55+
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
56+
57+
### Pull Requests
58+
59+
* Include screenshots and animated GIFs in your pull request whenever possible.
60+
* Include thoughtfully-worded, well-structured tests.
61+
* Document new code
62+
* End files with a newline.
63+
64+
65+
Happy Coding from the HelloFresh Engineering team!

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<p align="center">
2+
<a href="https://hellofresh.com">
3+
<img width="120" src="https://www.hellofresh.de/images/hellofresh/press/HelloFresh_Logo.png">
4+
</a>
5+
</p>
6+
7+
# hellofresh/stats-php
8+
9+
[![Build Status](https://travis-ci.org/hellofresh/stats-php.svg?branch=master)](https://travis-ci.org/hellofresh/stats-php)
10+
[![Coverage Status](https://codecov.io/gh/hellofresh/stats-php/branch/master/graph/badge.svg)](https://codecov.io/gh/hellofresh/stats-php)
11+
12+
> Generic Stats library written in PHP
13+
14+
This is generic stats library that we at HelloFresh use in our projects to collect services' stats and then create monitoring
15+
dashboards to track activity and problems.
16+
17+
## Key Features
18+
19+
* Several stats backends:
20+
* `log` for development environment
21+
* `statsd` for production
22+
* `noop` for environments that do not require any stats gathering
23+
* Fixed metric sections count for all metrics to allow easy monitoring/alerting setup in `grafana`
24+
* Easy to build HTTP requests metrics - timing and count
25+
* Generalise or modify HTTP Requests metric - e.g. skip ID part
26+
27+
## Installation
28+
29+
```sh
30+
composer require hellofresh/stats-php
31+
```
32+
33+
TBD

0 commit comments

Comments
 (0)