Skip to content

Commit df6c297

Browse files
authored
Merge pull request #36 from magento-cia/MC-42011
MC-42011: Update Readme.md of security package
2 parents f83f872 + c308f9f commit df6c297

File tree

1 file changed

+14
-60
lines changed

1 file changed

+14
-60
lines changed

README.md

Lines changed: 14 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,23 @@
1-
<h2>Welcome</h2>
2-
Welcome to Magento 2 installation! We're glad you chose to install Magento 2, a cutting-edge, feature-rich eCommerce solution that gets results.
1+
# Magento Security Package
32

4-
## Magento System Requirements
5-
* [Magento System Requirements](https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html)
3+
Welcome to the Magento Security Package community project!
64

7-
## Install Magento
5+
## Overview
86

9-
* [Installation Guide](https://devdocs.magento.com/guides/v2.4/install-gde/bk-install-guide.html)
7+
Magento security package provides a set of security-related features including two-factor authentication for admins, Google ReCAPTCHA support for various forms, and Security.txt to support vulnerability
8+
disclosure practices.
109

11-
<h2>Contributing to the Magento 2 Code Base</h2>
12-
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, optimizations, or just good suggestions.
10+
## Documentation
1311

14-
To learn about how to make a contribution, click [here][1].
15-
16-
To learn about issues, click [here][2].
17-
18-
To open an issue, click [here][3].
19-
20-
To suggest documentation improvements, click [here][4].
21-
22-
[1]: https://devdocs.magento.com/contributor-guide/contributing.html
23-
[2]: https://devdocs.magento.com/contributor-guide/contributing.html#report
24-
[3]: https://github.com/magento/security-package/issues
25-
[4]: <https://devdocs.magento.com>
26-
27-
<h3>Community Maintainers</h3>
28-
The members of this team have been recognized for their outstanding commitment to maintaining and improving Magento. Magento has granted them permission to accept, merge, and reject pull requests, as well as review issues, and thanks these Community Maintainers for their valuable contributions.
29-
30-
<a href="https://magento.com/magento-contributors#maintainers">
31-
<img src="https://raw.githubusercontent.com/wiki/magento/magento2/images/maintainers.png"/>
32-
</a>
33-
34-
<h3>Top Contributors</h3>
35-
Magento is thankful for any contribution that can improve our code base, documentation or increase test coverage. We always recognize our most active members, as their contributions are the foundation of the Magento Open Source platform.
36-
<a href="https://magento.com/magento-contributors">
37-
<img src="https://raw.githubusercontent.com/wiki/magento/magento2/images/contributors.png"/>
38-
</a>
39-
40-
### Labels Applied by the Magento Team
41-
We apply labels to public Pull Requests and Issues to help other participants retrieve additional information about current progress, component assignments, Magento release lines, and much more.
42-
Please review the [Code Contributions guide](https://devdocs.magento.com/contributor-guide/contributing.html#labels) for detailed information on labels used in Magento 2 repositories.
43-
44-
## Reporting Security Issues
45-
46-
To report security vulnerabilities or learn more about reporting security issues in Magento software or web sites visit the [Magento Bug Bounty Program](https://hackerone.com/magento) on hackerone. Please create a hackerone account [there](https://hackerone.com/magento) to submit and follow-up your issue.
47-
48-
Stay up-to-date on the latest security news and patches for Magento by signing up for [Security Alert Notifications](https://magento.com/security/sign-up).
49-
50-
## License
51-
52-
Each Magento source file included in this distribution is licensed under OSL 3.0 or the Magento Enterprise Edition (MEE) license.
53-
54-
[Open Software License (OSL 3.0)](https://opensource.org/licenses/osl-3.0.php).
55-
Please see [LICENSE.txt](https://github.com/magento/security-package/blob/develop/LICENSE.txt) for the full text of the OSL 3.0 license or contact [email protected] for a copy.
56-
57-
Subject to Licensee's payment of fees and compliance with the terms and conditions of the MEE License, the MEE License supersedes the OSL 3.0 license for each source file.
58-
Please see LICENSE_EE.txt for the full text of the MEE License or visit https://magento.com/legal/terms/enterprise.
12+
- Complete documentation located on the project [wiki pages](https://github.com/magento/security-package/wiki):
13+
- How to start local development described in the [installation guide](https://github.com/magento/security-package/wiki/Metapackage-Installation-Guide)
14+
- Two-factor authentication [user guide](https://docs.magento.com/user-guide/stores/security-two-factor-authentication.html) and [technical guide](https://devdocs.magento.com/guides/v2.4/security/two-factor-authentication.html).
15+
- Google ReCAPTCHA [user guide](https://docs.magento.com/user-guide/stores/security-google-recaptcha.html) and [technical guide](https://devdocs.magento.com/guides/v2.4/security/google-recaptcha.html).
16+
- Security.txt [user guide](https://docs.magento.com/user-guide/configuration/security/security-txt.html) and [technical guide](https://devdocs.magento.com/guides/v2.4/security/security-txt.html).
5917

6018
## Community Engineering Slack
6119

62-
To connect with Magento and the Community, join us on the [Magento Community Engineering Slack](https://magentocommeng.slack.com). If you are interested in joining Slack, or a specific channel, send us request at [[email protected]](mailto:[email protected]) or [self signup](https://tinyurl.com/engcom-slack).
63-
64-
65-
We have channels for each project. These channels are recommended for new members:
20+
To connect with Magento team and the Community, join us on the [Magento Community Engineering Slack](https://magentocommeng.slack.com).
21+
If you are interested in joining Slack, or a specific channel, use our [self signup](https://opensource.magento.com/slack) link.
6622

67-
- [general](https://magentocommeng.slack.com/archives/C4YS78WE6): Open chat for introductions and Magento 2 questions
68-
- [github](https://magentocommeng.slack.com/archives/C7KB93M32): Support for GitHub issues, pull requests, and processes
69-
- [public-backlog](https://magentocommeng.slack.com/archives/CCV3J3RV5): Discussions of the Magento 2 backlog
23+
Magento security Slack channel: [#security](https://magentocommeng.slack.com/archives/CANPJTBC5)

0 commit comments

Comments
 (0)