kasoka
/
LRR
forked from mrlan/LRR
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README.md: update

Hui-improve-README.md
Lan Hui 2021-10-24 13:32:03 +08:00
parent c48624dd6a
commit 138f35ad4d
1 changed files with 32 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -1,17 +1,17 @@
# About LRR # About LRR
LRR (Lab Report Repository) is an online software application for posting assignments, submitting assignments and marking (re-marking) assignments. LRR (Lab Report Repository) is an online software application for course instructors to post, receive and mark assignments, and for students to submit assignments, or submit re-marking requests.
This software was originally developed by by Mahomed Nor, a graduate student in the Department of Computer Science at the Zhejiang Normal University, This software was originally developed by by Mahomed Nor in 2018, a graduate student in the Department of Computer Science at the Zhejiang Normal University,
while he was taking a graduate course called **Advanced Software Engineering** (http://lanlab.org/course/2018f/se/homepage.html). while he was taking a graduate course called **Advanced Software Engineering** (http://lanlab.org/course/2018f/se/homepage.html).
The LRR's project home page is at http://118.25.96.118/nor/homepage/index.html. The LRR's project home page is at http://121.4.94.30/homepage/. For potential project contributors, we recommend that you browse its home page first to familiarize yourselves with the project.
# Mission # Mission
Our mission is to make the experience of submitting assignments great for tens of hundreds of students in the department of computer science at the Zhejiang Normal University (Jinhua City, Zhejiang Province). Our mission is to make the experience of submitting assignments great for tens of hundreds of students in the department of computer science at the Zhejiang Normal University.
@ -51,7 +51,7 @@ Visit the LRR application by entering this URL in a web browser: http://121.4.94
## Enock's steps ## Enock's steps
Enock has made a tutorial about how he deployed LRR to a remote server (http://lanlab.org/course/2021s/spm/PuTTY-Server.txt). Enock, a former graduate student here, has made a tutorial about how he deployed LRR to a remote server (http://lanlab.org/course/2021s/spm/PuTTY-Server.txt).
@ -59,20 +59,20 @@ Enock has made a tutorial about how he deployed LRR to a remote server (http://l
# Current Status # Current Status
This software has been actively used by students who took or are This software has been actively used by students who took or are
taking courses (Introduction to Software Engineering and Software taking courses taught by Hui, e.g., Introduction to Software
Project Management) taught by Hui. Engineering, Introduction to Object-oriented analysis and design,
Advanced Software Engineering, Software Architecture, and Software
Project Management.
There are more than 200 student accounts created since its first There are more than 500 student accounts created since its first
launch in 2018. launch in 2018.
A running instance of this software is at http://118.25.96.118/nor/ A running instance of this software is at http://118.25.96.118/nor/
There are about 40 bugs (most being CRITICAL) that remain unresolved There are about 40 bugs (most being CRITICAL) that remain unresolved
before LRR can hit its beta release. See the section *The Bug before LRR can hit its Beta release. See the section *The Bug
Tracker* for more detail. Currently, there are a few groups (formed Tracker* for more detail. Currently, there are a few students who are
by students who are taking Software Project Management) working on taking my Advanced Software Engineering course) working on these bugs.
these bugs.
@ -80,16 +80,15 @@ these bugs.
We use Bugzilla to track LRR's bugs and feature requests. We use Bugzilla to track LRR's bugs and feature requests.
Most bugs of this software are recorded on the bug tracker for LRR: Most bugs are [recorded on Bugzilla](http://118.25.96.118/bugzilla/buglist.cgi?bug_status=__all__&list_id=1319&order=Importance&product=Lab%20Report%20Repository%20%28nor%20houzi%29&query_format=specific).
http://118.25.96.118/bugzilla/describecomponents.cgi?product=Lab%20Report%20Repository%20%28nor%20houzi%29
# TODO # TODO
- *Receiving email for password resetting*. Password resetting link is not always sent successfully. - [Priority low] *Receiving email for password resetting*. Password resetting link is not always sent successfully.
- *How assignements should be stored?* Creating sub-directories on all student submissions course-code/semester/section-number. (/student-number/course-code/semester/section-number/assignement-title/submission.txt) - [Priority medium] *Discuss how assignements should be stored?* `/student-number/course-code/semester/section-number/assignement-title/submission.txt`
- [SOLVED] Editing the assignment title after uploading a new assignment (instructor). - [SOLVED] Editing the assignment title after uploading a new assignment (instructor).
@ -105,24 +104,15 @@ We welcome your participation in this project.
Your participation does not have to be in the form of contributing code. You could help us on Your participation does not have to be in the form of contributing code. You could help us on
ideas, suggestions, documentation, etc. ideas, suggestions, documentation, etc.
You can fork this project and start working on your fork. After you are done, please create a pull request so that we could review your changes and give you feedback.
You need to be an invited member of *Lan Laboratory* before you can You will use the feature-branching workflow (see below).
push your feature branch or bugfix branch to the central reops at The main point of this workflow is
https://github.com/lanlab-org that you work on a branch on your local drive, push that branch to a remote
repository, and create a Pull Request (i.e., Pull Me Request) at
Send Hui (lanhui at zjnu.edu.cn) an email message including your for other people to review your changes. If everything is
GitHub account name so that he could invite you to be a member of *Lan
Laboratory*.
As of March 31 2020, there are 30 members in *Lan Laboratory* (https://github.com/orgs/lanlab-org/people).
You will use the feature-branching workflow (see below) when
interacting with the central repo. The main point of this workflow is
that you work on a branch on your local drive, push that branch to the
central repo, and create a Pull Request (i.e., Pull Me Request) at
GitHub for other people to review your changes. When everything is
OK, then *someone* could merge your changes to the master branch in the OK, then *someone* could merge your changes to the master branch in the
central repo. central repository.
I believe that *code review* at the Pull Request stage is important I believe that *code review* at the Pull Request stage is important
for both improving code quality and improving team quality. for both improving code quality and improving team quality.
@ -133,22 +123,23 @@ for both improving code quality and improving team quality.
We will use the feature-branching workflow for collaboration. The We will use the feature-branching workflow for collaboration. The
idea is that you make your own branch, work on it, and push this branch to idea is that you make your own branch, work on it, and push this branch to
the central repo for review. the remote, online repository for code review.
Check the section **The feature-branching workflow** in the following link for more detail: Check the section **The feature-branching workflow** in the following link for more detail:
https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst
## Testing
Make sure your changes can pass all the tests in folder `./test`.
## Communications Method ## Communications Method
For real-time communication, check our IRC channel `#lrr` at irc.freenode.org. Check this link http://lanlab.org/course/2020s/spm/irc-instruction.txt To submit bug reports or improvement ideas, please contact Hui [lanhui at zjnu.edu.cn]. He could open a Bugzilla account for you.
for how to use IRC.
To submit bug reports or improvement ideas, please ask Hui [lanhui at zjnu.edu.cn] to open a Bugzilla account for you.
We can also communicate through pull request. You make a pull request, I review it and comment on it, and you revise your pull request until everyone is happy so that your changes get merged to the master branch.
@ -159,7 +150,7 @@ To submit bug reports or improvement ideas, please ask Hui [lanhui at zjnu.edu.c
A: You missed two folders `css` and `font-awesome`. These folders include third-party js or css files and therefore are not included. A: You missed two folders `css` and `font-awesome`. These folders include third-party js or css files and therefore are not included.
1. Q: What if I do not have any information about the `lrr` database? 1. Q: What if I do not have any information about the `lrr` database?
A: You could use `lrr(1).sql` or `lrr_database.sql`. It seems `lrr(1).sql` is more complete. A: You could use `lrr_database.sql` to make a new database.