Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • A license, either AGPL or Apache. Here’s how to choose: /wiki/spaces/OPEN/pages/13959332

  • An openedx.yaml file. See OEP-2: Repository Metadata for details.

  • A README file (README.rst) with:

    • A sentence (ideally more) describing what the repo is. A brief summary of what it is for, and who might be interested is useful. More details can be covered in ADRs (described in OEP-19: Developer Documentation).

    • A link to the code of conduct: https://open.edx.org/code-of-conduct/

    • A mention of the license.

    • A statement about the repo’s contribution stance. For example:

      • “We welcome contributions”, with a link to a Contributing document [TODO: update a good org-wide contribution document.]

      • “We are not accepting public contributions to this repo.”

    • Contact information. This can simply be oscm@edx.org.

    • Security reporting information: “Please do not report security issues in public. Please Send security concerns via email to security@edx.org.”

A public repo should have:

...