Skip to content

Latest commit

 

History

History
142 lines (93 loc) · 4.81 KB

README.rst

File metadata and controls

142 lines (93 loc) · 4.81 KB
Raw

Grid Synergy edx-platform fork

Hack.d Lawrence McDaniel

Developers

  • open-release/* branches are locked. Do not attempt to push commits to any of these branches.
  • gs/* branches are limited. You'll need to use pull requests. You should create your own personal feature branch, make your code commits to this branch, push these commits, and then create a pull request.

The default branch of this repo is gs/koa.master. You should create your feature branches from this branch, and you should rebase often.

# Branch gs/koa.master was created as follows
#   -------------------------------------------
git checkout open-release/koa.master
git checkout -b gs/koa-master
git push --set-upstream origin gs/koa.master


# This fork is sync'd to edx/edx-platform using the following pull/rebase procedure
# 1.) pull any new commits from edx/edx-platform
# -------------------------------------------
git checkout open-release/koa.master
git pull
git push

# 2.) rebase gs/koa.master with these new commits
# -------------------------------------------
git checkout gs/koa.master
git rebase open-release/koa.master
git push

This is the core repository of the Open edX software. It includes the LMS (student-facing, delivering courseware), and Studio (course authoring) components.

Testing

Following is a shortcut for getting started running tests in your local environment.

# run python tests without compiling assets, but running migrations
paver test_system -s lms --fasttest --enable-migrations --verbose --disable_capture

Official Testing how-to documentation is located here: https://github.com/grid-synergy/edx-platform/blob/master/docs/guides/testing/testing.rst

Installation

Installing and running an Open edX instance is not simple. We strongly recommend that you use a service provider to run the software for you. They have free trials that make it easy to get started: https://openedx.org/get-started/

If you will be modifying edx-platform code, the Open edX Developer Stack is a Docker-based development environment.

If you want to run your own Open edX server and have the technical skills to do so, Open edX Installation Options explains your options.

License

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. Please see the LICENSE file for details.

More about Open edX

See the Open edX site to learn more about the Open edX world. You can find information about hosting, extending, and contributing to Open edX software. In addition, the Open edX site provides product announcements, the Open edX blog, and other rich community resources.

Documentation

Documentation can be found at https://docs.edx.org.

Getting Help

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack team.

For more information about these options, see the Getting Help page.

Issue Tracker

We use JIRA for our issue tracker, not GitHub issues. You can search previously reported issues. If you need to report a problem, please make a free account on our JIRA and create a new issue.

How to Contribute

Contributions are welcome! The first step is to submit a signed individual contributor agreement. See our CONTRIBUTING file for more information – it also contains guidelines for how to maintain high code quality, which will make your contribution more likely to be accepted.

Reporting Security Issues

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