CPT304 Software Engineering II
Assignment 2
Open-Source Investigation and Contribution
|
Start date
|
19th April
|
|
Submission date
|
17th May
|
|
Assignment type
|
Group assignment (4 members)
|
|
Percentage in final marks
|
10%
|
|
Deliverables
|
. Assignment report.
|
|
Late submission policy
|
5% of the awarded marks shall be deducted for each working day after the submission date, up to a maximum of five working days. Late submission for more than five working days will be not accepted.
|
|
Important notes
|
. Plagiarism results in award of ZERO mark; all submissions will be checked by TurnItIn.
. The formal procedure for submitting coursework at XJTLU is strictly followed. Submission link on Learning Mall will be provided in due course. The submission timestamp on Learning Mall will be used to check late submission.
|
Learning Outcome:
. C. Understand the key technological drivers behind contemporary software engineering research.
. D. Understand articles in the research literature of software engineering.
. F. Knowledge and understanding of the methods and issues involved in deploying systems to meet business goals.
Objective: Investigate the process of becoming an open-source contributor and apply the learned principles by contributing to an open-source project. This project requires you to work in team to cultivate your teamwork skills. You should work as a team to conduct the investigation and contribute to an open-source project as if you are an individual.
This team assignment not only allows students to collaborate and distribute work, but also teaches them about the open-source community and the value of open-source contributions. The addition of the initial investigation phase introduces a research component and ensures that all students have a strong understanding of open-source processes before making their own contribution.
Assignment Steps:
1. Open Source Investigation - Research the open-source community and the process of becoming an active contributor. Each team member should take on a different aspect of the investigation, such as understanding open-source licenses, different ways of contributing (code, documentation, bug reports, community management), finding suitable projects, and the typical process of submitting contributions to a project.
2. Collaborative Report - Each team will compile their findings into a comprehensive report. This report should cover all aspects of the open-source contribution.
3. Project Selection - Each team needs to select an open-source project that they're interested in. They should include the justification of their choice based on their investigation and the scope for potential contributions into the report.
4. Contribution Plan - Each team must create a detailed plan outlining what their
contribution to the project will be. They should divide the tasks among team members, each person having a clear role in the contribution. The contribution plan must also be included into the report.
5. Implementation and Proof of Work - Teams will then implement their contribution and submit proof of their work as part of the report. This can be done in the form of pull requests, commit records, before-and-after comparison screenshots, or updates to project documentation.
Grading:
1. Investigation (50%) - The thoroughness and clarity of the team's investigation into the open-source contribution process. Did they cover all key aspects? Is their report informative, well-structured, concise, and coherent?
2. Contribution Plan (15%) - The feasibility and value of the proposed contribution. Does the plan make sense? Does each team member have a clear role?
3. Implementation (35%) - The quality and impact of the team's contribution to the open- source project. Did they fork the project? Did they commit code to their branch and make the pull request? Did their work accept by the maintainer?
Grouping:
. All teams MUST consist of 4 members and register in LM (Register Your Team) before 24 April.
. Each team must select a group leader, who will be responsible for the assignment submission.
. After completing the assignment, before your submission, group leader must call for a meeting to conduct a peer evaluation using the below “Individual Contribution” form. The form. must be signed by all members and attached to the appendix in the report.
Submission:
1. You must submit the assignment report in PDF format via Learning Mall by the above submission date. Name the report as CPT304-A2-Report-GroupLeaderID.pdf
2. The report MUST NOT be more than 8 pages (excluding the cover page). Marks will only be given to the first 8 pages of your report.