bounswe / bounswe2023group9

Collaborative Science Platform aims to transform the way scientific research is conducted by providing a structured and collaborative approach to developing the knowledge in any scientific domain.

Welcome to CMPE352 Group 9's Project Repository

Hi! We are students from Bogazici University and this is our project for the Fundamentals of Software Engineering course.

📓 Description

This project aims to transform the way scientific research is conducted by providing a structured and collaborative approach to developing the knowledge in any scientific domain. The platform will be designed to reflect the natural organization of scientific knowledge, which is arranged in a directed acyclic graph, with each new discovery building on previous ones.

👥 Group Members

Ahmed Bera Pay	Ahmet Abdullah Susuz	Ali Mert Geben	Arda Arslan	Hakan Emre Aktaş
Leyla Yayladere	Mehmet Süzer	Oğuz Pançuk	Ömer Şükrü Uyduran	Zülal Molla
Ömer Faruk Ünal	Bengisu Kübra Takkin

📃 Wiki Page

You can go to our Wiki page and learn more about us from here.

bounswe2023group9's Issues

Collaboration Request Class

Collaboration Request Class is to be prepared for the Class Diagram

Meeting #3 Notes should be added

• Notes taken in meeting at 15/03/2023 should be added according to Meeting Notes Template
• A related Wiki page should be created and put in appropriate position in Wiki sidebar

Similar Projects should be studied

Projects similar to ours should be found and examined. We should also contact stakeholders if we can.

Theorem Class

Theorem Class is to be prepared for the Class Diagram

Account Class

Account Class is to be prepared for the Class Diagram.

Proof Class

Proof Class is to be prepared for the Class Diagram

Basic User

Meeting Template should be prepared.

A standard template for group members including:

• Topics
• Notes
• Attendees
• Duration
• Location

must be prepared.

Class Diagram for the Project

Issue Description

Class Diagram for the project should be prepared. Classes include the following;

Steps

• #38
• #39
• #40
• #41
• #42
• #43
• #44
• #45
• #46
• #47
• #56
• #48
• #49
• #50
• #51
• #52
• #53
• #54
• #55

Deadline for the Issue

07.04.2023

Creation of the High Level Mock-ups for Mobile

Issue Description

High level mock-ups for mobile should be created.

Steps

• Mock-up for scientist/contributor scenarios should be created and added to the related page
• Mock-up for reviewer scenarios should be created and added to the related page
• Mock-up for guest user scenarios should be created and added to the related page
• Mock-up for collaborator scenarios should be created and added to the related page

Deadline for the Issue

06/04/2023 Thursday - 23.59

Revision of the High Level Mock-ups

Issue Description

Product owner has pointed out some issues in the mock-ups we provided. They should be revised according to their wishes.

Steps

• Current edges statement should be changed
• The topic chosen for the mock-up should be changed
• Collaborating Contributor page is missing in the wiki
• Reviewer should only review the final entry
• Reviewer shouldn't create issues/tasks, just comments
• The ability to add theorem nodes
• Some one else can add a proof to a theorem posted by someone

Deadline for the Issue

02.04.2023 Sunday - 23.59

Issue Template should be prepared.

A template for group members to easily create GitHub issues must be prepared.

creation and documentation of high-level mock-ups

Issue Description

the documentation of detailed, comprehensive, and realistic high-level mock-up scenarios to how the requirements could satisfy the project owner.

Mock-up Scenarios

• Scenario creation for non-logged in user and non-contributor
• Scenario creation for contributor
• Scenario creation for reviewer

Mock-up Web pages

• Log in page
• Sign up page
• Home/explore page for non logged in user
• Home/explore page for logged in user
• Home/explore page with keyword search
• #21
• #19
• #22
• #23

Deadline for the Issue

20.03.2023 - Monday

Sidebar should be edited

Wiki page contains necessary information to represent general information about our repo. Sidebar should be modified in order to make viewer reach wiki pages easily, which are divided mainly as

• Home
• Group Members
• Research
• Meeting Notes
• Templates

Further development of the sidebar is always welcomed. New headings to be added when necessary.

Scenarios and Mock-up | Criteria

Issue Description

Criteria parts of the scenarios should be filled with the corresponding requirements

Steps

• Requirements should be examined
• Whether or not scenarios satisfy the requirements should be checked
• Necessary parts of the wiki pages should be edited

Deadline for the Issue

20.03.2023 Monday 13.00

Wiki home page should be edited

Wiki home page should include:

• Project description
• Details about our group
• Meeting Notes
• Research
• Requirements

Contributor

Meeting #6 Notes should be added

Issue Description

• Notes taken in meeting at 30/03/2023 should be added according to Meeting Notes Template
• A related Wiki page should be created and put in appropriate position in Wiki sidebar

Workspace Class

Workspace Class is to be prepared for the Class Diagram.

Admin Class

Admin Class is to be prepared for the Class Diagram.

Reviewer Class

Reviewer Class is to be prepared for the Class Diagram.

Entry Class

Entry Class is to be prepared for the Class Diagrams.

Collaborator workspace page

This page should demonstrate;

• Collaboration request
• Workspace Ownership

Question about Annotation Requirements - I would like to hear your opinion!

Problem & Question

Some requirements don't seem coherent within themselves to me, and I wonder if I missed something. Should annotations be created by Basic Users? If so, should we refer to these annotations as Private Annotations, which can only be seen by their creator, while Public Annotations are created by contributors and can be seen by anyone?

Related Requirements

I have realized while reviewing Use Case diagrams. These are the requirements which contradict with each other:

• 1.1.1.2.2 Basic users shall be able to create annotations for a node.
• 1.2.4.1 Annotations shall be added by contributors of the node.

Suggestion

Since Basic Users are not allowed to create node, they can't be contributor of a node. I suggest that we should delete Requirement 1.1.1.2.2. Other possible solution, separating Annotations as Public and Private.

Need your opinion - Thank you!

I would appreciate your opinion on this matter. Please share your ideas in the comments, indicating whether you agree or disagree with me. Additionally, please mention which solution you think is the best among possible options. I will revise the related requirements accordingly to the majority's decision.

Documenting Questions About Requirements

After studying project description in our group meeting, we prepared questions that will be asked in the project owner (teaching stuff) meeting to gain information about the project. Although these questions were resolved in the meeting with Utkan Hoca, we believe it would be helpful to document them in the project's Wiki for future reference.

• Open Wiki page under Requirements section
• Document Questions About Requirements

Search Class

Search Class is to be prepared for the Class Diagram

Guest User Class

Guest User Class is to be prepared for the Class Diagram.

Meeting #4 Notes should be added

Issue Description

• Notes taken in meeting at 22/03/2023 should be added according to Meeting Notes Template
• A related Wiki page should be created and put in appropriate position in Wiki sidebar

Extended/more detailed page for a node

Details of each node will be shown in a unique page. Page should include:

• Content of the Node
• Creator/Creation Date details
• Links to Predecessor and Successor Nodes
• Q&A Part

Meeting #7 Notes should be added

Issue Description

• Notes taken in meeting at 05/04/2023 should be added according to Meeting Notes Template.
• A related Wiki page should be created and put in appropriate position in Wiki sidebar.

Node Class

Node Class is to be prepared for the Class Diagram

Review Request Class

Review Request Class is to be prepared for the Class Diagram

Requirements should be documented

Basic requirements should be documented for the project.

README file should be edited

README file should at least include,

• Project Description
• Introduction to team members

Any additions are most welcome

Wiki Pages for Team Members Should be Added

Everyone in the group should add a page to Wiki that introduces themselves.

• Ali Mert Geben
• Hakan Emre Aktaş
• Ufuk Altunbulak
• Arda Arslan
• Ahmet Bera Pay
• Zülal Molla
• Leyla Yayladere
• Ömer Şükrü Uyduran
• Rafet Oğuz Pançuk
• Ahmet Abdullah Susuz
• Mehmet Süzer

Meeting #1 Notes should be added.

• Notes taken in meeting at 08/03/2023 should be added according to Meeting Notes Template
• A related Wiki page should be created and put in appropriate position in Wiki sidebar

Learning Best Practices for GitHub Issue Labels and Creating Required Labels

Aim : make easier to get information about the issue by searching a particular label attached to it

These are the label categories we decided to create:

• Priority

• Effort/Size

• Type

• Status

Github documentation about managing labels.
This blog might be helpful.

Request Class

Request Class is to be prepared for the Class Diagram

Meeting #5 Notes should be added

Issue Description

-Notes taken in meeting at 24/03/2023 should be added according to Meeting Notes Template
-A related Wiki page should be created and put in appropriate position in Wiki sidebar

Meeting #2 Notes should be added

• Notes taken in meeting at 13/03/2023 should be added according to Meeting Notes Template
• A related Wiki page should be created and put in appropriate position in Wiki sidebar

Basic User Class

Basic User Class is to be prepared for the Class Diagram.

Admin

Reviewer page with review request

This page should include;

• Notification to notify the reviewer to review
• Review process
• Approval and Publishing

Contributor Class

Contributor Class is to be prepared for the Class Diagram.

Each team member should select a repository and post a research page about them.

Each team member should select a repository and post a research page about them.

• Ali Mert Geben
• Hakan Emre Aktaş
• Ufuk Altunbulak
• Arda Arslan
• Ahmet Bera Pay
• Zülal Molla
• Leyla Yayladere
• Ömer Şükrü Uyduran
• Rafet Oğuz Pançuk
• Ahmet Abdullah Susuz
• Mehmet Süzer

Workspace page for contributor user (should have add node request)

Workspace for contributors should include:

• Main Workspace page where contributors create workspaces and entries to keep track of the progress
• A way to reach out to possible collaborators
• A way to send to review
• A way to resolve issues and proposed edges

Guest

Use Case Diagram will be implemented...

Issue Description

Use Case diagram specified according to requirements will be drawn according to users:

Steps

• #27
• #28
• #30
• #29
• #31
• #85

Deadline for the Issue

03.04.2023

Setting up a Communicator

a Communication channel should be established to ease the communication within the team.

Reviewer