microsoft / oxa-tools

Open edX on Azure Tools
MIT License
36 stars 103 forks source link

Oxa/ficus update readme #450

Closed prabhanshu closed 5 years ago

prabhanshu commented 5 years ago

What does this PR do? Please provide some context

Updated Readme in order to get better community engagement, questions and contribution. Though it will go through thorough review from OXA teams I have just create a PR just have a look at the changes made to README file

Where should the reviewer start?

How can this be manually tested? (brief repro steps and corpnet-URL with change)

What are the relevant TFS items? (list id numbers)

Definition of done:

Reminders DURING merge

  1. If you're merging from a short-term (feature) branch into a long-term branch (like dev, release, or master) then "Squash and merge" to keep our history clean.
  2. If merging from two longterm branches (like cherry picks from upstream, dev to release, etc) then "Create merge commit" to preserve individual commits.
eltoncarr commented 5 years ago

Isn't this too much? I think we should leverage as much of the install doc/pdf as opposed to listing all the steps here.