Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ReadMe] updated readMe file for Contact-CurrensySumbol modules #31638

Open
wants to merge 3 commits into
base: 2.4-develop
Choose a base branch
from
Open

[ReadMe] updated readMe file for Contact-CurrensySumbol modules #31638

wants to merge 3 commits into from

Conversation

vlmed
Copy link
Contributor

@vlmed vlmed commented Jan 13, 2021

Description (*)

Update README.md file for modules:

  • Magento_Contact
  • Magento_Cookie
  • Magento_Cron
  • Magento_Csp
  • Magento_CurrencySymbol

Fixed Issues (if relevant)

  1. magento/devdocs README content for modules - work in M2 Code devdocs#4451: README content for modules - work in M2 Code

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

@m2-assistant
Copy link

m2-assistant bot commented Jan 13, 2021

Hi @vlmed. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@vlmed vlmed force-pushed the update_readme_contact_currency-symbol branch from 82ff751 to 2cd4996 Compare January 13, 2021 14:46
@rogyar rogyar self-assigned this Jan 14, 2021
@gabrieldagama gabrieldagama added Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. labels Jan 14, 2021
rogyar
rogyar requested changes Jan 17, 2021
View reviewed changes
Copy link
Contributor

@rogyar rogyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @vlmed. Awesome piece of job, thank you. Please, check my suggestions.

app/code/Magento/Contact/README.md Outdated
Magento_Contact module provides an implementation of "Contact Us" feature based on sending email message, allows to configure email recipients, email template, etc...

## Installation details
Before installing this module, note that the Magento_Contact is dependent on the Magento_Store module
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Before installing this module, note that the Magento_Contact is dependent on the Magento_Store module
Before installing this module, note that the Magento_Contact is dependent on the Magento_Store module.

app/code/Magento/Contact/README.md Outdated

### Configuration
Use the `Stores -> Configuration -> General -> Contacts -> Contact Us -> Enable Contact Us` configuration to enable or disable module functionality.
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Send Email To` configuration to select the recipients email
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Send Email To` configuration to select the recipients email
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Send Email To` configuration to select the recipients email.

app/code/Magento/Contact/README.md Outdated
### Configuration
Use the `Stores -> Configuration -> General -> Contacts -> Contact Us -> Enable Contact Us` configuration to enable or disable module functionality.
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Send Email To` configuration to select the recipients email
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Sender` configuration to select the senders email
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Sender` configuration to select the senders email
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Sender` configuration to select the senders email.

app/code/Magento/Contact/README.md Outdated
Use the `Stores -> Configuration -> General -> Contacts -> Contact Us -> Enable Contact Us` configuration to enable or disable module functionality.
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Send Email To` configuration to select the recipients email
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Sender` configuration to select the senders email
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Template` configuration to select the emails template
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Template` configuration to select the emails template
Use the `Stores -> Configuration -> General -> Contacts -> Email Options -> Email Template` configuration to select the emails template.

app/code/Magento/Cookie/README.md Outdated
Magento_Cookie module allows enabling and configuring HTTP cookie related settings for the store. These settings are available in the store administration.
# Magento_Cookie module

This module allows enabling and configuring HTTP cookie related settings for the store.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This module allows enabling and configuring HTTP cookie related settings for the store.
This module allows enabling and configuring HTTP cookie-related settings for the store.

app/code/Magento/Cookie/README.md Outdated
# Magento_Cookie module

This module allows enabling and configuring HTTP cookie related settings for the store.
Allows to enable cookie restricition mode.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Allows to enable cookie restricition mode.
Allows enabling cookie restriction mode.

app/code/Magento/Cron/README.md Outdated

This module enables scheduling of cron jobs.
Other modules can add cron jobs by including crontab.xml in their etc directory.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Other modules can add cron jobs by including crontab.xml in their etc directory.
Other modules can add cron jobs by including crontab.xml in their `etc` directory.

app/code/Magento/Csp/README.md Outdated
For more information, see [Whitelist an inline script or style](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/security/content-security-policies.html#whitelist-an-inline-script-or-style)

#### Page specific Content-Security-Policies
Magento can send unique policies for a specific page. To do so, implement Magento\Csp\Api\CspAwareActionInterface in a controller responsible for the page and define the modifyCsp method
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Magento can send unique policies for a specific page. To do so, implement Magento\Csp\Api\CspAwareActionInterface in a controller responsible for the page and define the modifyCsp method
Magento can send unique policies for a specific page. To do so, implement Magento\Csp\Api\CspAwareActionInterface in a controller responsible for the page and define the `modifyCsp` method

app/code/Magento/CurrencySymbol/README.md Outdated

**CurrencySymbol** enables the creation of custom currencies and management of currency conversion rates.
This module enables the creation of custom currencies and management of currency conversion rates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This module enables the creation of custom currencies and management of currency conversion rates.
This module enables creating custom currencies and managing currency conversion rates.

app/code/Magento/CurrencySymbol/README.md Outdated
***CurrencySymbol\Controller\Adminhtml\System\Currency\FetchRates.php*** gets a specified currency conversion rate.
Supports all defined currencies in the system.
***CurrencySymbol\Controller\Adminhtml\System\Currency\SaveRates.php*** saves rates for defined currencies.
Before installing this module, note that the Magento_CurrencySymbol is dependent on the Magento_Widget module
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Before installing this module, note that the Magento_CurrencySymbol is dependent on the Magento_Widget module
Before installing this module, note that the Magento_CurrencySymbol is dependent on the Magento_Widget module.

@rogyar rogyar added Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Progress: review Award: category of expertise and removed Progress: needs update labels Jan 17, 2021
@vlmed vlmed force-pushed the update_readme_contact_currency-symbol branch from 2cd4996 to 5b11d68 Compare January 18, 2021 07:53
@vlmed
Copy link
Contributor Author

vlmed commented Jan 18, 2021

Hi @rogyar. Thanks for suggestions. I added it to my commit.

@engcom-Hotel engcom-Hotel self-assigned this Jan 18, 2021
@engcom-Hotel
Copy link
Contributor

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

1 similar comment
@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests CE

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

1 similar comment
@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests EE

@engcom-Hotel engcom-Hotel requested a review from rogyar January 22, 2021 07:50
@engcom-Hotel engcom-Hotel removed their assignment Feb 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rogyar rogyar Awaiting requested review from rogyar

Assignees

@rogyar rogyar

Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Award: category of expertise Component: Contact Component: Cookie Component: Cron Component: Csp Component: CurrencySymbol Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: pending review Release Line: 2.4 Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@vlmed @engcom-Hotel @rogyar @gabrieldagama @magento-engcom-team