pages

The README.rst file should start with a brief description of the repository, which sets it in the context of other repositories under the edx organization. It should make clear where this fits in to the overall edX codebase.

Pages with hierarchical structure

Overview (please modify)

The README.rst file should then provide an overview of the code in this repository, including the main components and useful entry points for starting to understand the code in more detail.

Documentation

The full documentation is at https://pages.readthedocs.org.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome.

Please read How To Contribute for details.

Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.

PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md

Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you can find it at ISSUE_TEMPLATE.md

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org.

Getting Help

Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.