Skip to content

Commit bcfc906

Browse files
committed
initial commit
0 parents  commit bcfc906

File tree

5,493 files changed

+862790
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

5,493 files changed

+862790
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
The primary source of the Code of Conduct is at [mautic.org](https://www.mautic.org/code-of-conduct/) - it is reproduced here for reference.
2+
3+
## 1. Purpose
4+
5+
A primary goal of the Mautic community is to support you and your business in the development, use and implementation of Mautic. It’s to be inclusive and add value to the largest number of participants, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all.
6+
7+
This code of conduct outlines our expectations for all those who participate in our community, whether in-person or online, as well as the consequences for unacceptable behavior.
8+
9+
Your participation is contingent upon following these guidelines in all Mautic activities, including but not limited to:
10+
11+
* Using Mautic community resources.
12+
* Working with other Mauticians and other Mautic community participants whether virtually or co-located.
13+
* Representing Mautic at public events.
14+
* Representing Mautic in social media (official accounts, personal accounts, Facebook pages and groups).
15+
* Participating in Mautic sprints and training events.
16+
* Participating in Mautic-related forums, mailing lists, wikis, websites, chat channels, bugs, group or person-to-person meetings, and Mautic-related correspondence.
17+
18+
We invite all those who participate in Mautic activities online to help us create safe and positive experiences for everyone, everywhere.
19+
20+
21+
## 2. Open Source & Culture Citizenship
22+
23+
A supplemental goal of this Code of Conduct is to increase open source and culture citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
24+
25+
Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
26+
27+
If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, please recognize their efforts.
28+
29+
## 3. Welcoming to all
30+
We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience or job role, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, national origin, citizenship and immigration status, neurodiversity, mental health or socio-economic status.
31+
32+
33+
## 4. Expected Behavior
34+
35+
The following behaviors are expected and requested of all community members:
36+
37+
* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
38+
* Exercise consideration and respect in your speech and actions.
39+
* Attempt collaboration before conflict.
40+
* Guide conversations toward issue resolution.
41+
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
42+
43+
Alert Mautic team members if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
44+
45+
## 5. Unacceptable Behavior
46+
47+
The following behaviors are considered harassment and are unacceptable within our community:
48+
49+
* **Violence and Threats of Violence** are not acceptable - online or offline. This includes incitement of violence toward any individual, including encouraging a person to commit self-harm. This also includes posting or threatening to post other people’s personally identifying information (“doxxing”) online.
50+
* **Public or private harassment** is never acceptable in any form.
51+
* **Personal Attacks** Conflicts will inevitably arise, but frustration should never turn into a personal attack. It is not okay to insult, demean or belittle others. Attacking someone for their opinions, beliefs and ideas is not acceptable. It is important to speak directly when we disagree and when we think we need to improve, but such discussions must be conducted respectfully and professionally, remaining focused on the issue at hand.
52+
* **Derogatory Language** Hurtful or harmful language is never acceptable in any context related to: background, family status, gender, gender identity or expression, marital status, sex, sexual orientation, personal appearance, body size, native language, age, ability, neurodiversity, mental health, race and/or ethnicity, national origin, citizenship and immigration status, socioeconomic status, religion, geographic location.
53+
* **Unwelcome Sexual Attention or Physical Contact** Unwelcome sexual attention or unwelcome physical contact is not acceptable. This includes sexualized comments, jokes or imagery in interactions, communications or presentation materials, as well as inappropriate touching, groping, or sexual advances. This includes touching a person without permission, including sensitive areas such as their hair, pregnant stomach, mobility device (wheelchair, scooter, etc) or tattoos. This also includes physically blocking or intimidating another person. Physical contact or simulated physical contact (such as emojis like “kiss”) without affirmative consent is not acceptable. This includes sharing or distribution of sexualized images or text.
54+
* **Disruptive Behavior** Sustained disruption of events, forums, or meetings, including talks and presentations, will not be tolerated. This includes spamming community discussions with the solicitation of unwanted products or services.
55+
* **Influencing Disruptive Behavior** We will treat influencing or leading such activities the same way we treat the activities themselves, and thus the same consequences apply.
56+
57+
## 6. Consequences of Unacceptable Behavior
58+
59+
Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
60+
61+
Anyone asked to stop unacceptable behavior is expected to comply immediately.
62+
63+
If a community member engages in unacceptable behavior, we may take any action deemed appropriate, up to and including a temporary ban or permanent expulsion from the community without warning. Examples of sanctions which may be applied include but is not limited to:
64+
* Verbal warnings.
65+
* Written warnings.
66+
* Temporary absence from participation.
67+
* Long-term absence from participation.
68+
* Being required to follow a conduct agreement that dictates the process of returning to the community.
69+
70+
71+
## 7. Reporting Guidelines
72+
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify us as soon as possible by emailing [email protected], or contacting a Mautic team member on the specific platform.
73+
74+
Processes for dealing with breaches of the Code of Conduct can be found [here][coc-breaches].
75+
76+
## 8. Addressing Grievances
77+
Only permanent resolutions (such as bans) may be appealed. To appeal a decision, contact the Mautic team at [email protected] with your appeal and the team will review the situation.
78+
79+
## 9. Scope
80+
We expect all community participants (contributors, moderators and other guests) to abide by this Code of Conduct in all community venues–online and in-person–as well as in all one-on-one communications pertaining to community affairs.
81+
82+
While this code of conduct is specifically aimed at Mautic’s official resources and community, we recognize that it is possible for actions taken outside of Mautic’s official online or in person spaces to have a deep impact on community health.
83+
84+
Resources or incidents which break this code of conduct for any reason in a non-Mautic community location will be considered in the same way as resources or incidents from owned channels, and subject to the same sanctions.
85+
86+
## 10. Contact info
87+
For more information, please contact [email protected].
88+
89+
## 11. License and attribution
90+
This Code of Conduct is directly adapted from the Stumptown Syndicate and distributed under a [Creative Commons Attribution-ShareAlike license][cc-by-sa].
91+
92+
Additional text from [Mozilla Community Participation Guidelines][mozilla-guidelines] distributed under a [Creative Commons Attribution-ShareAlike license][cc-by-sa].
93+
94+
Reviewed and updated using the [Mozilla Code of Conduct Assessment Tool][mozilla-tool].
95+
96+
[coc-breaches]: </policies/code-of-conduct-breaches>
97+
[mozilla-guidelines]: <https://www.mozilla.org/en-US/about/governance/policies/participation/>
98+
[cc-by-sa]: <https://creativecommons.org/licenses/by-sa/3.0/>
99+
[mozilla-tool]:<https://mozilla.github.io/diversity-coc-review.io>
100+
101+
(Code of Conduct is subject to change without notice).

.github/CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
## Reporting Security Vulnerabilities
2+
3+
If you think that you have found a security vulnerability, please email [email protected] with as much detail as possible. The core team will review the vulnerability and if found applicable, will create the patch in a private repository. The vulnerability will be disclosed once the patch has been included into a release.
4+
5+
## Contributing Code
6+
7+
Development is open and available to any member of the Mautic community. All fixes and improvements are done through pull requests to the code. This code is open source and publicly available.
8+
9+
### Developer Documentation
10+
11+
Developer documentation is available at [https://developer.mautic.org](https://developer.mautic.org). To add additions or corrects to the documentation, submit Issues or Pull Requests against [https://github.com/mautic/developer-documentation](https://github.com/mautic/developer-documentation).
12+
13+
### Core Feature Development Procedures
14+
15+
Pull Requests with additional features should be created with the Mautic Core goals in consideration. Any features that are created for core that don’t follow the overall goals may not be included.
16+
17+
In addition to following the general direction of the development goals, the pull request code must be well-formed following coding standards and guidelines. If you wish to target a specific release version number for the feature, its best to make the pull request early so any feedback from the core team can be implemented and adequate testing can be performed.
18+
19+
Features that are determined not to fit within the direction of the Mautic Core goals are more than welcome to be created as plugins instead.
20+
21+
### Code Contribution Requirements
22+
23+
#### Code Standards
24+
25+
Mautic follows [Symfony's coding standards](http://symfony.com/doc/current/contributing/code/standards.html) by implementing pre-commit git hook running [php-cs-fixer](https://github.com/friendsofphp/php-cs-fixer), which is installed and updated with `composer install`/`composer update`.
26+
27+
All code styling is handled automatically by the aforementioned git hook. In case if you setup git hook correctly (which is true if you ever run `composer install`/`composer update` before creating a pull request), you can format your code as you like - it will be converted to Mautic code style automatically.
28+
29+
#### Automated Tests
30+
31+
All code contributions should include adequate and appropriate unit tests using [PHPUnit](https://phpunit.de/manual/5.7/en/index.html) and/or Symfony functional tests ([https://symfony.com/doc/2.8/testing.html](https://symfony.com/doc/2.8/testing.html)). Pull Requests without these tests will not be merged.
32+
33+
#### Pull Request Description
34+
35+
When creating a new Pull Request, the description template should be filled appropriately in detail. Any Pull Request that does not have an appropriate description will not be considered for merge.
36+
37+
#### Documentation
38+
39+
Each new feature should include a reference to a pull request in our [End User Documentation](https://github.com/mautic/documentation) repository or [Developer Documentation](https://github.com/mautic/developer-documentation) repository if applicable.
40+
41+
## Core Development Rules
42+
43+
Pull requests and code submissions are decided upon by the release leader and the core team. When a decision is not clearly evident then the following voting process will be implemented.
44+
45+
### Voting Policy
46+
47+
Votes are cast by all members of the core team. Votes can be changed at any time during the discussion. Positive votes require no explanation. A negative vote must be justified by technical or objective logic. A core team member cannot vote on any code they submit.
48+
49+
### Merging Policy
50+
51+
The voting process on any particular pull request must allow for enough time for review by the community and the core team. This involves a minimum of 2 days for minor modifications and minimum of 5 days for significant code changes. Minor changes involve typographical errors, documentation, code standards, minor CSS, javascript, and HTML modifications. Minor modifications do not require a voting process. All other submissions require a vote after the minimum code review period and must be approved by two or more core members (with no core members voting against).
52+
53+
### Core Membership Application
54+
55+
Core team members are based on a form of meritocracy. We actively seek to empower our active community members and those demonstrating increased involvement will be given everything needed for their continued success.
56+
57+
### Core Membership Revocation
58+
59+
A Mautic Core membership can be revoked for any of the following reasons:
60+
61+
- Refusal to follow the rules and policies listed herein
62+
- Lack of activity for the previous 6 months
63+
- Willful negligence or intent to harm the Mautic project
64+
- Upon decision of the project leader
65+
66+
Revoked members may re-apply for core membership following a 12 month period.

.github/FUNDING.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: mautic
2+
open_collective: mautic

.github/ISSUE_TEMPLATE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[//]: # (READ THIS BEFORE PUBLISHING YOUR ISSUE)
2+
3+
[//]: # (Please post questions, support requests and feature requests/ideas at https://forum.mautic.org.)
4+
[//]: # (Strictly follow the instructions hereunder, otherwise your issue will be closed for lack of information.)
5+
[//]: # (DO NOT report security vulnerabilities here. Send them to [email protected].)
6+
[//]: # (MAUTIC 2 is not supported any more (except for security matters), report your issue only if it relates to the Mautic 3 series.)
7+
8+
Detail your bug report:
9+
10+
| Q | A
11+
| ---| ---
12+
| Confirm it is a Bug report |
13+
| Mautic version | **MAUTIC 2 is not supported any more**
14+
| PHP version |
15+
16+
[//]: # (Feature request? ---> Go to forum please ---> https://forum.mautic.org/c/ideas)
17+
[//]: # (Enhancement? ---> Go to forum please ---> https://forum.mautic.org/c/ideas)
18+
[//]: # (Need support, have questions? ---> Go to forum please ---> https://forum.mautic.org/c/support)
19+
20+
## Description:
21+
The more details the better...
22+
23+
24+
### Steps to reproduce:
25+
1.
26+
2.
27+
28+
### Log errors:
29+
30+
_Please check for related errors in the latest log file in [mautic root]/app/log/ and/or the web server's logs and post them here. Be sure to remove sensitive information if applicable._
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report
4+
labels: needs-triage
5+
6+
---
7+
8+
[//]: # ( Invisible comment:
9+
IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
10+
Before you create the issue:
11+
IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
12+
Search for similar report among other reported issues.
13+
Learn how to troubleshoot at https://www.mautic.org/docs/en/tips/troubleshooting.html
14+
Use drag&drop to attach images or other files )
15+
16+
## Bug Description
17+
The more details the better...
18+
19+
| Q | A
20+
| --- | ---
21+
| Mautic version |
22+
| PHP version |
23+
| Browser |
24+
25+
### Steps to reproduce
26+
1.
27+
2.
28+
29+
### Log errors
30+
31+
32+
[//]: # ( Invisible comment:
33+
Please check for related errors in the latest log file in [mautic root]/app/log/ and/or the web server's logs and post them here. Be sure to remove sensitive information if applicable. )
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Feature request
3+
about: Please share your ideas and find support at https://forum.mautic.org/c/ideas
4+
labels: needs-triage
5+
6+
---
7+
8+
We've decided to use GitHub issues as a bug tracker only so the bug reports wouldn't be hidden in long list of ideas and support questions. Please go to https://forum.mautic.org/c/ideas to find support and discuss features.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Security vulnerability
3+
about: Please DO NOT report security vulnerabilities here. Send them to [email protected]
4+
instead.
5+
labels: needs-triage
6+
7+
---
8+
9+
Please DO NOT report security vulnerabilities here. Send them to [email protected] instead. Give developers time to solve the security vulnerability before the report will be published.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
| Q | A
2+
| -------------------------------------- | ---
3+
| Branch? | "features" for features or enhancements / 3.2 for bug fixes <!-- see below -->
4+
| Bug fix? | yes/no
5+
| New feature? | yes/no
6+
| Deprecations? | yes/no
7+
| BC breaks? | yes/no
8+
| Automated tests included? | yes/no
9+
| Related user documentation PR URL | mautic/mautic-documentation#... <!-- required for new features -->
10+
| Related developer documentation PR URL | mautic/developer-documentation#... <!-- required for developer-facing changes -->
11+
| Issue(s) addressed | Fixes #... <!-- prefix each issue number with "Fixes #", no need to create an issue if none exists, explain below instead -->
12+
13+
<!--
14+
Additionally (see https://contribute.mautic.org/contributing-to-mautic/developer/code/pull-requests#step-5-work-on-your-pull-request):
15+
- Always add tests and ensure they pass.
16+
- Bug fixes must be submitted against the lowest maintained branch where they apply
17+
(lowest branches are regularly merged to upper ones so they get the fixes too.)
18+
- Features and deprecations must be submitted against the "features" branch.
19+
-->
20+
21+
<!--
22+
Please write a short README for your feature/bugfix. This will help people understand your PR and what it aims to do.
23+
-->
24+
#### Description:
25+
26+
<!--
27+
If you are fixing a bug and if there is no linked issue already, please provide steps to reproduce the issue here.
28+
-->
29+
30+
#### Steps to test this PR:
31+
1. Load up [this PR](https://mautibox.com)
32+
2.
33+
34+
<!--
35+
If you have any deprecations, list them here along with the new alternative.
36+
If you have any backwards compatibility breaks, list them here.
37+
-->

0 commit comments

Comments
 (0)