diff --git a/README.rst b/README.rst index 7ff79f16..bfd5998a 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,15 @@ -|Build Status| |Codecov| |license| - frontend-app-discussions ======================== -Please tag **@edx/fedx-team** on any PRs or issues. Thanks. +|Build Status| |Codecov| |license| -Introduction ------------- +Purpose +------- This repository is a React-based micro frontend for the Open edX discussion forums. -**Installation and Startup** +Getting Started +--------------- 1. Clone your new repo: @@ -26,6 +25,39 @@ This repository is a React-based micro frontend for the Open edX discussion foru The dev server is running at `http://localhost:2002 `_. +Getting Help +------------ +Please tag **@edx/fedx-team** on any PRs or issues. Thanks. +If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community. +For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide. + +https://github.com/openedx/frontend-app-discussions/issues + +For more information about these options, see the `Getting Help`_ page. + +.. _Getting Help: https://openedx.org/getting-help + +How to Contribute +----------------- +Details about how to become a contributor to the Open edX project may be found in the wiki at `How to contribute`_ + +.. _How to contribute: https://openedx.org/r/how-to-contribute + + +The Open edX Code of Conduct +---------------------------- +All community members should familarize themselves with the `Open edX Code of Conduct`_. + +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ + +People +------ +The assigned maintainers for this component and other project details may be found in Backstage or groked from inspecting catalog-info.yaml. + +Reporting Security Issues +------------------------- +Please do not report security issues in public. Please email security@edx.org. + Project Structure ----------------- @@ -48,4 +80,4 @@ Please see `edx/frontend-platform's i18n module `) or a user (`user:`). + # Don't forget the "user:" or "group:" prefix. Groups must be GitHub team + # names in the openedx GitHub organization: https://github.com/orgs/openedx/teams + # + # If you need a new team created, create an issue with tCRIL engineering: + # https://github.com/openedx/tcril-engineering/issues/new/choose + owner: group:infinity + + # (Required) Acceptable Type Values: service, website, library + type: 'website' + + # (Required) Acceptable Lifecycle Values: experimental, production, deprecated + lifecycle: 'production' \ No newline at end of file