Skip to content

Commit 650b522

Browse files
authored
Create contributing.md
1 parent 326ccac commit 650b522

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

contributing.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# How to Contribute
2+
3+
Already a PHP Developer? Familiar with Symfony, DDD, Event Sourcing and/or CQRS? Pick an issue, push a PR and instantly
4+
become a member of the Open Loyalty contributors community.
5+
6+
Thank you for your interest in, and engagement with this project. We intend to provide this solution for companies and
7+
developers willing to build great loyalty applications all over the world and would like to encourage you to join us in
8+
creating the best open source platform for this purpose.
9+
10+
Before you type an issue please check the main
11+
[readme](https://github.com/DivanteLtd/pimcore-classification-tree/blob/master/readme.md)
12+
13+
Issue reporting guidelines:
14+
* Always define type of issue:
15+
* Bug report
16+
* Feature request
17+
* While writing issues, be as specific as possible
18+
* All requests regarding support with implementation or application setup should be sent to us
19+
20+
Here’s how to submit a pull request:
21+
* __Fork the repository__ and clone it locally. Connect your local repository to the original “upstream” repository by adding
22+
it as a remote repository. Pull in changes from “upstream” often in order to stay up to date so that when you submit your
23+
pull request, merge conflicts will be less likely.
24+
* __Create a branch__ for your edits. Use the following branch naming conventions:
25+
* bugfix/task-title
26+
* feature/task-name
27+
* __Reference any relevant issues__ or supporting documentation in your PR (ex. “XYZ: 39. Issue title.”).
28+
* __Include screenshots of the before and after__ if your changes include differences in HTML/CSS. Drag and drop the images
29+
into the body of your pull request.
30+
* __Test your changes!__ Run your changes against any existing tests and create new ones when needed. Make sure your changes
31+
don’t break the existing project.
32+
* __Contribute in the style of the project__ and follow the
33+
[code of conduct](https://github.com/DivanteLtd/pimcore-classification-tree/blob/master/code_of_conduct.md) and
34+
[coding standards](https://symfony.com/doc/current/contributing/code/standards.html)
35+
* __Check build status on Travis.__ It always should be green.
36+
37+
# Reporting Potential Security Issues
38+
If you have found a potential security vulnerability, please DO NOT report it on the public issue tracker. Instead, send it
39+
to us. We will work with you to verify and fix it as soon as possible.
40+
41+
Please provide the following information:
42+
* Bundle(s) affected
43+
* Description of how to reproduce the issue
44+
* The impact on the application
45+
* If possible, an idea how to fix the vulnerability.

0 commit comments

Comments
 (0)