silverstripe-comments/README.md
2022-07-14 12:06:51 +12:00

45 lines
1.9 KiB
Markdown

# Comments
[![CI](https://github.com/silverstripe/silverstripe-comments/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-comments/actions/workflows/ci.yml)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/silverstripe/silverstripe-comments.svg)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-comments/?branch=master)
[![SilverStripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
[![Code Coverage](https://img.shields.io/codecov/c/github/silverstripe/silverstripe-comments.svg)](https://codecov.io/gh/silverstripe/silverstripe-comments)
## Introduction
This module provides commenting functionality for Pages and other DataObjects on your SilverStripe site.
For more documentation about the module see the provided documentation located inside the docs folder.
## Requirements
* SilverStripe ^4.0
**Note:** This branch is compatible with SilverStripe 4. For a SilverStripe 3 release, please see the 2.x release line.
## Installation
```
composer require silverstripe/comments
```
See docs/en/Installing.md
## Related
* [silverstripe/comment-notifications](https://github.com/silverstripe/comment-notifications): Comment admin email notifications module
## Contributing
### Translations
Translations of the natural language strings are managed through a
third party translation interface, transifex.com.
Newly added strings will be periodically uploaded there for translation,
and any new translations will be merged back to the project source code.
Please use https://www.transifex.com/projects/p/silverstripe-comments/ to contribute translations,
rather than sending pull requests with YAML files.
See the ["i18n" topic](https://docs.silverstripe.org/en/4/developer_guides/i18n/) on doc.silverstripe.org for more details.