Skip to content

Commit cfef6b7

Browse files
authored
Merge branch 'develop' into MQE-1994
2 parents 1b3f5cf + 96d3268 commit cfef6b7

File tree

10 files changed

+290
-120
lines changed

10 files changed

+290
-120
lines changed

.github/CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Magento 2 Page Builder code
2+
3+
Contributions to the Magento 2 Page Builder codebase are done using the fork & pull model.
4+
This contribution model has contributors maintaining their own fork of the Magento 2 Page Builder repository.
5+
The forked repository is then used to submit a request to the base repository to “pull” a set of changes.
6+
For more information on pull requests please refer to [GitHub Help](https://help.github.com/articles/about-pull-requests/).
7+
8+
Contributions can take the form of new components or features, changes to existing features, tests, documentation (such as developer guides, user guides, examples, or specifications), bug fixes or optimizations.
9+
10+
The Magento 2 Page Builder development team or community maintainers will review all issues and contributions submitted by the community of developers in the first in, first out order.
11+
During the review we might require clarifications from the contributor.
12+
If there is no response from the contributor within two weeks, the pull request will be closed.
13+
14+
For more detailed information on contribution please read our [beginners guide](https://github.com/magento/magento2/wiki/Getting-Started).
15+
16+
## Contribution requirements
17+
18+
1. Contributions must adhere to the [Magento coding standards](https://devdocs.magento.com/guides/v2.3/coding-standards/bk-coding-standards.html).
19+
2. Pull requests (PRs) must be accompanied by a meaningful description of their purpose. Comprehensive descriptions increase the chances of a pull request being merged quickly and without additional clarification requests.
20+
3. Commits must be accompanied by meaningful commit messages. Please see the [Magento 2 Page Builder Pull Request Template](PULL_REQUEST_TEMPLATE.md) for more information.
21+
4. PRs which include bug fixes must be accompanied with a step-by-step description of how to reproduce the bug.
22+
3. PRs which include new logic or new features must be submitted along with:
23+
* Unit/integration test coverage
24+
* Proposed [documentation](https://devdocs.magento.com) updates. Documentation contributions can be submitted via the [devdocs GitHub](https://github.com/magento/devdocs).
25+
4. For larger features or changes, please [open an issue](https://github.com/magento/magento2-page-builder/issues) to discuss the proposed changes prior to development. This may prevent duplicate or unnecessary effort and allow other contributors to provide input.
26+
27+
## Contribution process
28+
29+
If you are a new GitHub user, we recommend that you create your own [free github account](https://github.com/signup/free).
30+
Also, you need to participate in [Magento Partner Program](https://magento.com/partners/become).
31+
This will allow you to collaborate with the Magento 2 Page Builder development team, fork the Magento 2 Page Builder project and send pull requests.
32+
33+
1. Search current [listed issues](https://github.com/magento/magento2-page-builder/issues) (open or closed) for similar proposals of intended contribution before starting work on a new contribution.
34+
2. Review the [Contributor License Agreement](https://opensource.adobe.com/cla.html) if this is your first time contributing.
35+
3. Create and test your work.
36+
4. Fork the Magento 2 Page Builder repository according to the [Fork A Repository instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#fork) and when you are ready to send us a pull request – follow the [Create A Pull Request instructions](https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html#pull_request).
37+
5. Once your contribution is received the Magento 2 Page Builder development team will review the contribution and collaborate with you as needed.
38+
39+
## Code of Conduct
40+
41+
Please note that this project is released with a Contributor Code of Conduct. We expect you to agree to its terms when participating in this project.
42+
The full text is available in the repository [Wiki](https://github.com/magento/magento2/wiki/Magento-Code-of-Conduct).
43+
44+
## Connecting with Community!
45+
46+
If you have any questions, join us in [#pagebuilder](https://magentocommeng.slack.com/archives/CHB455HPF) Slack chat. If you are not on our slack, [click here](https://opensource.magento.com/slack) to join.
47+
48+
Need to find a project? Check out the [Slack Channels](https://github.com/magento/magento2/wiki/Slack-Channels) (with listed project info) and the [Magento Community Portal](https://opensource.magento.com/).

.github/ISSUE_TEMPLATE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!---
2+
Thank you for contributing to Magento.
3+
To help us process this issue we recommend that you add the following information:
4+
- Summary of the issue,
5+
- Information on your environment,
6+
- Steps to reproduce,
7+
- Expected and actual results,
8+
Fields marked with (*) are required. Please don't remove the template.
9+
10+
Please also have a look at our guidelines article before adding a new issue https://github.com/magento/magento2/wiki/Issue-reporting-guidelines
11+
-->
12+
13+
### Preconditions (*)
14+
<!---
15+
Please provide as detailed information about your environment as possible.
16+
For example Magento version, tag, HEAD, PHP & MySQL version, etc..
17+
-->
18+
1.
19+
2.
20+
21+
### Steps to reproduce (*)
22+
<!---
23+
It is important to provide a set of clear steps to reproduce this bug.
24+
If relevant please include code samples
25+
-->
26+
1.
27+
2.
28+
3.
29+
30+
### Expected result (*)
31+
<!--- Tell us what should happen -->
32+
1. [Screenshots, logs or description]
33+
34+
### Actual result (*)
35+
<!--- Tell us what happens instead -->
36+
1. [Screenshots, logs or description]

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Technical issue with the Magento 2 Page Builder
4+
5+
---
6+
7+
<!---
8+
Please review our guidelines before adding a new issue: https://github.com/magento/magento2/wiki/Issue-reporting-guidelines
9+
Fields marked with (*) are required. Please don't remove the template.
10+
-->
11+
12+
### Preconditions (*)
13+
<!---
14+
Provide the exact Magento Page Builder version (example: develop) and any important information on the environment where bug is reproducible.
15+
-->
16+
1.
17+
2.
18+
19+
### Steps to reproduce (*)
20+
<!---
21+
Important: Provide a set of clear steps to reproduce this bug. We can not provide support without clear instructions on how to reproduce.
22+
-->
23+
1.
24+
2.
25+
26+
### Expected result (*)
27+
<!--- Tell us what do you expect to happen. -->
28+
1. [Screenshots, logs or description]
29+
2.
30+
31+
### Actual result (*)
32+
<!--- Tell us what happened instead. Include error messages and issues. -->
33+
1. [Screenshots, logs or description]
34+
2.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Developer experience issue
3+
about: Issues related to customization, extensibility, modularity
4+
labels: 'Triage: Dev.Experience'
5+
6+
---
7+
8+
<!---
9+
Please review our guidelines before adding a new issue: https://github.com/magento/magento2/wiki/Issue-reporting-guidelines
10+
Fields marked with (*) are required. Please don't remove the template.
11+
-->
12+
13+
### Summary (*)
14+
<!--- Describe the issue you are experiencing. Include general information, error messages, environments, and so on. -->
15+
16+
### Examples (*)
17+
<!--- Provide code examples or a patch with a test (recommended) to clearly indicate the problem. -->
18+
19+
### Proposed solution
20+
<!--- Suggest your potential solutions for this issue. -->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: New features and improvements to the existing functionality
4+
labels: 'feature request'
5+
6+
---
7+
8+
<!---
9+
Important: Please describe the value of the requested feature. Fields marked with (*) are required. Please don't remove the template.
10+
-->
11+
12+
### Description (*)
13+
<!--- Describe the feature you would like to add. -->
14+
15+
### Expected behavior (*)
16+
<!--- What is the expected behavior of this feature? How is it going to work? -->
17+
18+
### Benefits
19+
<!--- How do you think this feature would improve Magento? -->
20+
21+
### Additional information
22+
<!--- What other information can you provide about the desired feature? -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
1-
## Scope
1+
<!---
2+
Thank you for contributing to Magento.
3+
To help us process this pull request we recommend that you add the following information:
4+
- Summary of the pull request,
5+
- Issue(s) related to the changes made,
6+
- Manual testing scenarios
7+
Fields marked with (*) are required. Please don't remove the template.
8+
-->
9+
10+
<!--- Please provide a general summary of the Pull Request in the Title above -->
11+
12+
### Description (*)
13+
<!---
14+
Please provide a description of the changes proposed in the pull request.
15+
Letting us know what has changed and why it needed changing will help us validate this pull request.
16+
-->
17+
218
### Story
319
<!---
420
* [<issue_number>](https://jira.corp.magento.com/browse/<issue_number>) <issue_title>
@@ -14,6 +30,13 @@
1430
* [<issue_number>](https://jira.corp.magento.com/browse/<issue_number>) <issue_title>
1531
-->
1632

33+
### Fixed Issues (if relevant)
34+
<!---
35+
If relevant, please provide a list of fixed issues in the format magento/magento2-page-builder#<issue_number>.
36+
There could be 1 or more issues linked here and it will help us find some more information about the reasoning behind this change.
37+
-->
38+
1. magento/magento2-page-builder#<issue_number>: Issue title
39+
1740
### Builds
1841
<!---
1942
[All-User-Requested-Tests](https://m2build-ur.devops.magento.com/job/All-User-Requested-Tests/<build_number>)
@@ -25,13 +48,22 @@ https://github.com/magento/magento2ce/pull/<related_pr>
2548
-->
2649
<!-- related pull request placeholder -->
2750

51+
### Manual testing scenarios (*)
52+
<!---
53+
Please provide a set of unambiguous steps to test the proposed code change.
54+
Giving us manual testing scenarios will help with the processing and validation process.
55+
-->
56+
1. ...
57+
2. ...
58+
59+
### Questions or comments
60+
<!---
61+
If relevant, here you can ask questions or provide comments on your pull request for the reviewer
62+
For example if you need assistance with writing tests or would like some feedback on one of your development ideas
63+
-->
64+
2865
### Checklist
29-
- [ ] PR is green on M2 Quality Portal
30-
- [ ] Jira issues have accurate summary, meaningful description and have links to relevant documentation at the story/task level
31-
- [ ] Semantic Version build failure is approved by architect (if build is red) <Architect Name>
32-
- [ ] Pull Request approved by architect <Architect Name>
33-
- [ ] Pull Request quality review performed by <name>
34-
- [ ] All unstable functional acceptance tests are isolated (if any)
35-
- [ ] All linked Zephyr tests are approved by PO and have Ready to Use status
36-
- [ ] Travis CI build is green (for mainline CE only)
37-
- [ ] Jenkins Extended FAT build is green
66+
- [ ] Pull request has a meaningful description of its purpose
67+
- [ ] All commits are accompanied by meaningful commit messages
68+
- [ ] All new or changed code is covered with unit/integration tests (if applicable)
69+
- [ ] All automated tests passed successfully (all builds are green)

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 engcom@magento.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: 0 additions & 37 deletions
This file was deleted.

COPYRIGHT.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Copyright © 2019-present Magento, Inc. All rights reserved.

0 commit comments

Comments
 (0)