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

Merge pull request #12 from lanlab-org/Hui-improve-README.md 

Hui improved README.md
SIMPLICITY_Bug-189_Course_Delete_btn
Teecloudy 2020-03-31 22:48:03 +08:00 committed by GitHub
parent 452ea2da0e 0d79b8923f
commit ac7fdbaef8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 105 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

163
README.md
View File

@ -11,19 +11,116 @@ The LRR's project home page is at http://118.25.96.118/nor/homepage/index.html.
# Mission
Our mission is to make the learning experience great for tens of hundreds of students in the department of computer science.
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).
# Installation Instructions
Check file INSTALLATION.md (TBA) for details.
# Current Status
This software has been actively used by students who took or are taking courses taught by Hui. There are more than 200 student accounts created since its first launch.
This software has been actively used by students who took or are
taking courses (Introduction to Software Engineering and Software
Project Management) taught by Hui.
There are more than 200 student accounts created since its first
launch in 2018.
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 before LRR can hit its beta release. See the section *The Bug Tracker* for more details.
There are about 40 bugs (most being CRITICAL) that remain unresolved
before LRR can hit its beta release. See the section *The Bug
Tracker* for more detail. Currently, there are a few groups (formed
by students who are taking Software Project Management) working on
these bugs.
Currently, there are a few groups (formed by students who are taking Software Project Management) working on these bugs.
# The Bug Tracker
We use Bugzilla to track LRR's bugs and feature requests.
Most bugs of this software are recorded on the bug tracker for LRR:
http://118.25.96.118/bugzilla/describecomponents.cgi?product=Lab%20Report%20Repository%20%28nor%20houzi%29
# TODO
- *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)
- *Feature request*. Editing the assignment title after uploading a new assignment (instructor).
- [SOLVED] A new user could not login immediately after sign up.
- A more complete list of TODO's is at http://lanlab.org/course/2020s/spm/decide-areas-for-improvement-review.html
# How to Contribute
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
ideas, suggestions, documentation, etc.
You need to be an invited member of *Lan Laboratory* before you can
push your feature branch or bugfix branch to the central reops at
https://github.com/lanlab-org
Send Hui (lanhui at zjnu.edu.cn) an email message including your
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
central repo.
I believe that *code review* at the Pull Request stage is important
for both improving code quality and improving team quality.
## The Feature-branching Workflow
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
the central repo for review.
Check the section **The feature-branching workflow** in the following link for more detail:
https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst
## 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
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.
## Frequently Asked Questions
Check FAQ.md (TBA) for details.
@ -32,63 +129,13 @@ Currently, there are a few groups (formed by students who are taking Software Pr
The original GitHub Repo is at https://github.com/EngMohamedNor/LabReportRepo
# The Bug Tracker
Most bugs of this software have been reported on the LRR bug tracker: http://118.25.96.118/bugzilla/describecomponents.cgi?product=Lab%20Report%20Repository%20%28nor%20houzi%29
# TODO
- [SOLVED] A new user could not login immediately after sign up.
- *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)
- *Feature request*. Editing the assignment title after uploading a new assignment (instructor).
We welcome your participation in this project. Your participation does not have to be coding. You could help us on ideas, suggestions, information, etc.
*Last modified on 22 March 2020*
# How to Contribute
You need to be an invited member of *Lan Laboratory* before you can push your feature branch or bugfix branch to the central reops at https://github.com/lanlab-org
Send Hui (lanhui at zjnu.edu.cn) an email message including your GitHub account name so that he could invite you to be a member of *Lan Laboratory*.
Currently, there are 9 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 you could merge your changes to the master branch in the
central repo.
I believe that *code review* at the Pull Request stage is a very important activity for effectively improving both code quality and team quality.
## The feature-branching workflow
Check the section **The feature-branching workflow** in the following link:
https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst
# Contributor List
(Please put your name and student number below.)
TanakaMichelle - Tanaka Michelle Sandati - 201732120134
WhyteAsamoah - Yeboah Martha Asamoah - 201732120135
xiaoyusoil - ZhengXiaoyu - 201732120110
xiaoyusoil - ZhengXiaoyu - 201732120110