Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,59 +1,20 @@ | ||
| Expertiza | ||
| E1971. OSS project Finklestein: Instructors & Institutions | ||
| ========= | ||
|
|
||
| [](https://travis-ci.org/expertiza/expertiza) | ||
| [](https://coveralls.io/github/expertiza/expertiza?branch=master) | ||
| [](https://codeclimate.com/github/expertiza/expertiza/maintainability) | ||
| **Team_4430:** | ||
| lli46, rwu5, yzhu48 | ||
|
|
||
| #### Peer review system | ||
| **Mentor** | ||
| Carmen Bentley (cnaiken@ncsu.edu) | ||
|
|
||
| Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. | ||
| **What is does:** | ||
| Models can have many associations. For example, a ‘role’ can have many ‘users’ and the reverse a ‘user’ belongs to a ‘role. One important association in the Expertiza system is that between instructors and the institutions to which they belong. This can be an important attribute to groups, restrict, and even validate user permissions. | ||
|
|
||
| Setup | ||
| ----- | ||
| **What’s wrong with it:** | ||
| Currently, models that can be associated with an institution are provided a pre-populated selection scroll when being created. This list should be presented in alphabetical order, but this is not the case when creating a new course. Additionally, and more importantly, there is an issue of associating an institution with a new instructor that is not listed in the selection scroll. | ||
|
|
||
| ### NCSU VCL image | ||
| **What needs to be done:** | ||
| * Fix Issue #987: The institution list should be sorted alphabetically. | ||
| * Fix Issue #964: Adding a new institution during creation of an instructor profile. | ||
| * Fix Issue #1188: Listing of instructors should show their institutions on the same line as their new feature. | ||
|
|
||
| The expertiza environment is already set up in [NC State's VCL](https://vcl.ncsu.edu) image "[CSC517, S18] Ruby on Rails / Expertiza". | ||
|
|
||
| Using the VCL is the quickest way to get started, but you may find it awkward developing on a remote machine | ||
| with network lag and having to reinstall gems every time you connect. Installing locally can be a pain though too. | ||
| Life is full of tradeoffs. :-) The good news is that you can start on one environment, push your work to git, | ||
| and switch to another environment if you don't like the one you started with. | ||
|
|
||
| ### Installing locally | ||
|
|
||
| See the Google doc on [setting up the Expertiza development environment](https://docs.google.com/document/d/1tXmwju6R7KQbvycku-bdXxa6rXSUN4BMyvjY3ROmMSw/edit). | ||
|
|
||
|
|
||
| <sub>Depreciation warning: See the Expertiza wiki for setup instructions. Please update the wiki with corrections or additional helpful information. (http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:OSX, http://wiki.expertiza.ncsu.edu/index.php/Development:Setup:Linux:RHEL, http://wiki.expertiza.ncsu.edu/index.php/Creating_a_Linux_Development_Environment_for_Expertiza_-_Installation_Guide)</sub> | ||
|
|
||
| Contributing | ||
| ------------ | ||
|
|
||
| * [Fork](http://help.github.com/fork-a-repo/) the expertiza project | ||
| * [Create a new branch](http://progit.org/book) for your contribution with a descriptive name | ||
| * [Commit and push](http://progit.org/book) until you are happy with your contribution - follow the style guidelines below | ||
| * Make sure to add tests for it; the tests should fail before your contribution/fix and pass afterward | ||
| * [Send a pull request](http://help.github.com/send-pull-requests) to have your code reviewed for merging back into Expertiza | ||
|
|
||
| Style Guidelines | ||
| ---------------- | ||
|
|
||
| We've had many contributors in the past who have used a wide variety of ruby coding styles. It's a mess, and we're trying to unify it. | ||
|
|
||
| All new files/contributions should: | ||
|
|
||
| * Use unix line endings (Windows users: configure git to use [autocrlf](http://help.github.com/line-endings)) | ||
| * Indent with 2 spaces (no tabs; configure your editor) both in ruby and erb | ||
| * Follow the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) style for syntax, formatting, and naming | ||
| * Follow the [design guidelines](https://github.com/expertiza/expertiza/blob/master/design_document.md) for the views. | ||
|
|
||
| When editing existing files: | ||
|
|
||
| * Keep the existing tabbing (use tabs instead of spaces in files that already use tabs everywhere; otherwise use spaces) | ||
| * Keep the existing line ending style (dos/unix) | ||
| * Follow the Ruby style Guide on code you add or edit, as above | ||
|
|
||
| Please do no go crazy changing old code to match these guidelines; it will just create lots of potential merge conflicts. | ||
| Applying style guidelines to code you add and modify is good enough. :-) |