Skip to content

Commit 3ec54f0

Browse files
fourhundredfourfourhundredfour
committed
Initial commit
0 parents  commit 3ec54f0

File tree

7 files changed

+419
-0
lines changed

7 files changed

+419
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Media/Logs**
24+
If applicable, add screenshots, videos or logs to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Question
3+
about: Feel free to ask a question about this project
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
**Check for duplicate**
11+
Check if your question has already been answered by a previous question.
12+
https://github.com/surplex/<repository>/labels/question

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# CONTRIBUTING
2+
First of all we want to say **Thank You❤** for taking the time to support our project.
3+
4+
## Introduction
5+
The following is a set of guidelines and rules to contribute to open-source projects, published by [Surplex](https://github.com/surplex).
6+
Feel free to propose changes to this document.
7+
8+
The key words **"MUST"**, **"MUST NOT"**, **"REQUIRED"**, **"SHALL"**, **"SHALL NOT"**, **"SHOULD"**, **"SHOULD NOT"**, **"RECOMMENDED"**, **"MAY"**, and **"OPTIONAL"** in this document are to be interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
9+
10+
11+
## Table of Contents
12+
* [Introduction](#introduction)
13+
* [Table of Contents](#table-of-contents)
14+
* [Styling Guide](#styling-guide)
15+
* [Coding Standards](#coding-standards)
16+
* [Branching Model](#branching-model)
17+
* [Testing](#testing)
18+
* [Pull Requests](#pull-requests)
19+
* [Labels](#labels)
20+
* [Reviewer](#reviewer)
21+
* [Assignee](#assignee)
22+
* [Questions](#questions)
23+
24+
## Style Guide
25+
To keep our project **consistent** and **clean**, every contributor **MUST** follow the rules and guidelines.
26+
27+
### Coding Standards
28+
The coding standards/conventions are usually defined in the README.md. If they do not exist, these fallback rules will apply:
29+
#### Default
30+
* Comments **MUST** be written in **English**.
31+
* The names of **structures**, **individual types**, **enums**, **classes**, **methods**, **variables**, **functions**, **properties** and **namespaces** **MUST** be written in **English**.
32+
* Magic Numbers **SHOULD NOT** be used.
33+
* The Name of a function or method **SHOULD** be descriptive.
34+
* Basically these principles **SHOULD** be used: Single Responsibility Principle, Open-Closed Principle, Liskov Substitution Principle, Interface Segregation Principle, Dependency Inversion Principle, YAGNI and KISS.
35+
36+
#### PHP
37+
Since other people have already thought about guidelines, the proposal is to adopt the guidelines from [PSR-12](https://www.php-fig.org/psr/psr-12/). [PSR-12](https://www.php-fig.org/psr/psr-12/) complements [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-2](https://www.php-fig.org/psr/psr-2/), so these two **MUST** also be considered.
38+
In addition, the following rules **MUST** be observed:
39+
* Classes **MUST** be written in **PascalCase** and set up according to [PSR-4](https://www.php-fig.org/psr/psr-4/) to ensure autoloading.
40+
* Variable names and method names **MUST** be written in **camelCase**.
41+
42+
### Branching Model
43+
For our project we use the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) Model which is introduced by Vincent Driessen.
44+
We extended the branching model by separating bugfixes from features.
45+
To commit a bugfix you **MUST** use the new branch type called **Bugfix** which is indicated by the prefix *bugfix/*.
46+
47+
## Testing
48+
To avoid unexpected behavior of the software we maintain and use automated tests.
49+
* Every change or implementation **MUST NOT** break any tests. When a test fails, the test or the code letting the test fails **MUST** be adjusted.
50+
* Every implementation of a new feature **MUST** have at least one unit test.
51+
* Every bugfix **SHOULD** have at least one test which tests this case.
52+
53+
## Pull Requests
54+
Each pull request **SHOULD** have the develop branch as it target branch and should conform the requirements described above.
55+
56+
### Labels
57+
To sort your pull request correctly, it **MUST** use the available labels.
58+
**Bug** - Use this label if you have a bugfix or bug report.
59+
**Documentation** - Use this label if you have a improvement or addition to documentation.
60+
**Duplicate** - This label is used by the members of the organization to identify duplicates.
61+
**Feature** - Use this label if you have a new feature or an idea for a new feature.
62+
**Question** - Use this label if you have a question.
63+
64+
### Reviewer
65+
Reviewers will be automatically assigned to your pull request.
66+
You can put your feet up and wait for your pull request to be accepted ;)
67+
68+
## Questions
69+
If you have questions about one of our open-source projects, then feel free to write an issue.
70+
If this is a general question that doesn't relate to an open source project, then write us a mail to [github@surplex.com](mailto:github@surplex.com).

0 commit comments

Comments
 (0)