From 339b62f9d373ddc18a5d66628e2c1588873e8d6e Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 21:34:00 +0800 Subject: [PATCH 01/11] README.md: update mission. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 564a9f4..84e6ad8 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ 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). From b2ca3e2b8ce48f720a1728959ff5e5f26a4a269f Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:00:13 +0800 Subject: [PATCH 02/11] README.md: update README.md. --- README.md | 86 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 62 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 84e6ad8..e334abd 100644 --- a/README.md +++ b/README.md @@ -15,54 +15,67 @@ Our mission is to make the experience of submitting assignments great for tens o +# 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. - -Currently, there are a few groups (formed by students who are taking Software Project Management) working on these bugs. - - - -# The Original GitHub Repo - -The original GitHub Repo is at https://github.com/EngMohamedNor/LabReportRepo +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. # 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 +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 -- [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* +- [SOLVED] A new user could not login immediately after sign up. # 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 +We welcome your participation in this project. -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*. +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*. Currently, there are 9 members in *Lan Laboratory* (https://github.com/orgs/lanlab-org/people). @@ -74,18 +87,43 @@ 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. +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: +## Communications method + +For real-time communication, check our IRC channel `#lrr` at irc.freenode.org. + +To submit bug reports or improvement ideas, please ask Hui [lanhui at zjnu.edu.cn] to open a Bugzilla account for you. + + + +## The Feature-branching Workflow + +We will use the feature-branching workflow for collaboration. The +idea is that 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 +## Frequently Asked Questions + +Check FAQ.md (TBA) for details. + + + +# The Original GitHub Repo + +The original GitHub Repo is at https://github.com/EngMohamedNor/LabReportRepo + # Contributor List -*Please put your name and student number below*. +(Please put your name and student number below.) From 70dec17a03eba68efec0e52171c40e8553a079a8 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:04:24 +0800 Subject: [PATCH 03/11] README.md: update the number of members in lanlab-org. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ec1e56..6ded212 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ 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). +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 From 02d70e9b6ee8bd1c0f6a6cc7c82cd67371550647 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:05:23 +0800 Subject: [PATCH 04/11] README.md: rearrange two subsections: Communications method and The Feature-branching Workflow. --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6ded212..9a48ad7 100644 --- a/README.md +++ b/README.md @@ -93,14 +93,6 @@ team quality. -## Communications method - -For real-time communication, check our IRC channel `#lrr` at irc.freenode.org. - -To submit bug reports or improvement ideas, please ask Hui [lanhui at zjnu.edu.cn] to open a Bugzilla account for you. - - - ## The Feature-branching Workflow We will use the feature-branching workflow for collaboration. The @@ -112,6 +104,17 @@ Check the section **The feature-branching workflow** in the following link for m https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst + +## Communications method + +For real-time communication, check our IRC channel `#lrr` at irc.freenode.org. + +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. From d812b738c1f9789f01df26ebd760a1c1ce302575 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:05:38 +0800 Subject: [PATCH 05/11] README.md: method -> Method. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a48ad7..a2d302e 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst -## Communications method +## Communications Method For real-time communication, check our IRC channel `#lrr` at irc.freenode.org. From 17f91958277845c84df23943f242854194883923 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:07:02 +0800 Subject: [PATCH 06/11] README.md: link to a tutorial on how to use IRC. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a2d302e..98660c9 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,8 @@ https://github.com/spm2020spring/TeamCollaborationTutorial/blob/master/team.rst ## Communications Method -For real-time communication, check our IRC channel `#lrr` at irc.freenode.org. +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. From 8bbbf5b3f7c7ad1c5359301e4677a869dc1d778f Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:08:11 +0800 Subject: [PATCH 07/11] README.md: we use Bugzilla. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 98660c9..de7c809 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ 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 From 29375b2c5f421e029e7814fb168ce0422cb66871 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:09:04 +0800 Subject: [PATCH 08/11] README.md: complete list of TODO's. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index de7c809..6cdf9cb 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ http://118.25.96.118/bugzilla/describecomponents.cgi?product=Lab%20Report%20Repo - [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 From 42d392a164a68fc725cf9215bbd90effae9eb6d7 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:11:13 +0800 Subject: [PATCH 09/11] README.md: update the section How to Contribute. --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6cdf9cb..a73a572 100644 --- a/README.md +++ b/README.md @@ -87,12 +87,11 @@ 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 +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 a very -important activity for effectively improving both code quality and -team quality. +I believe that *code review* at the Pull Request stage is important +for both improving code quality and improving team quality. From ce4194e63b98cbf5a3c01180e5b2dd8e8b6d211e Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:11:54 +0800 Subject: [PATCH 10/11] README.md: update The Feature-branching Workflow. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a73a572..e35a208 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ 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 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. Check the section **The feature-branching workflow** in the following link for more detail: From 0d79b8923ff79bdaa17f0019fb9cd0a1f9c84499 Mon Sep 17 00:00:00 2001 From: Hui Lan Date: Tue, 31 Mar 2020 22:16:12 +0800 Subject: [PATCH 11/11] README.md: add a new line in the end of README.md. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20439fc..0151569 100644 --- a/README.md +++ b/README.md @@ -138,4 +138,4 @@ TanakaMichelle - Tanaka Michelle Sandati - 201732120134 WhyteAsamoah - Yeboah Martha Asamoah - 201732120135 -xiaoyusoil - ZhengXiaoyu - 201732120110 \ No newline at end of file +xiaoyusoil - ZhengXiaoyu - 201732120110