SSE/WebsiteTheSSEquel
4
0
Fork 0
Code Issues 82 Pull requests 21 Projects Releases Packages Wiki Activity Actions

Resolve #206 "add open source process documentation" #207

Merged
2nPlusOne merged 3 commits from 206-task-add-open-source-process-documentation into main 2025-10-07 15:56:36 +00:00
Conversation 13 Commits 3 Files changed 6 +507 -3
2nPlusOne commented 2025-05-20 01:08:56 +00:00 (Migrated from github.com)
Copy link
No description provided.
copilot-pull-request-reviewer[bot] (Migrated from github.com) reviewed 2025-05-20 01:09:08 +00:00
copilot-pull-request-reviewer[bot] (Migrated from github.com) left a comment
Copy link

Pull Request Overview

This pull request resolves #206 by adding comprehensive open source process documentation and updating related project files. The key changes include:

  • Removal of the root package.json file.
  • Reorganizing type dependencies in next/package.json.
  • Addition of detailed documentation files (VisionAndScope.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and CHANGELOG.md) and updates to the README.md.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
package.json Removed the file—ensure the build/configuration is updated to reflect this change.
next/package.json Moved @types/react and @types/react-dom from dependencies to devDependencies to better separate runtime from development dependencies.
documentation/VisionAndScope.md Added detailed project vision and scope documentation.
README.md Updated contributing instructions and environment setup guide references.
CONTRIBUTING.md New file outlining the contribution process, coding style, and testing guidelines.
CODE_OF_CONDUCT.md New file that establishes community standards and expectations for behavior.
CHANGELOG.md New file that tracks the project's notable changes and version history.
Comments suppressed due to low confidence (2)

package.json:1

  • The removal of the root package.json file may impact build tools or configurations that rely on it. Please confirm that all build processes and tooling now reference next/package.json appropriately.
-{

next/package.json:16

  • Moving @types/react and @types/react-dom to devDependencies is a good practice if they are only required during development. Please verify that there is no runtime dependency on these type definitions.
-    "@types/react": "18.2.21",
## Pull Request Overview This pull request resolves #206 by adding comprehensive open source process documentation and updating related project files. The key changes include: - Removal of the root package.json file. - Reorganizing type dependencies in next/package.json. - Addition of detailed documentation files (VisionAndScope.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and CHANGELOG.md) and updates to the README.md. ### Reviewed Changes Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments. <details> <summary>Show a summary per file</summary> | File | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------ | | package.json | Removed the file—ensure the build/configuration is updated to reflect this change. | | next/package.json | Moved @types/react and @types/react-dom from dependencies to devDependencies to better separate runtime from development dependencies. | | documentation/VisionAndScope.md | Added detailed project vision and scope documentation. | | README.md | Updated contributing instructions and environment setup guide references. | | CONTRIBUTING.md | New file outlining the contribution process, coding style, and testing guidelines. | | CODE_OF_CONDUCT.md | New file that establishes community standards and expectations for behavior. | | CHANGELOG.md | New file that tracks the project's notable changes and version history. | </details> <details> <summary>Comments suppressed due to low confidence (2)</summary> **package.json:1** * The removal of the root package.json file may impact build tools or configurations that rely on it. Please confirm that all build processes and tooling now reference next/package.json appropriately. ``` -{ ``` **next/package.json:16** * Moving @types/react and @types/react-dom to devDependencies is a good practice if they are only required during development. Please verify that there is no runtime dependency on these type definitions. ``` - "@types/react": "18.2.21", ``` </details>
2nPlusOne (Migrated from github.com) reviewed 2025-09-03 03:33:26 +00:00
CHANGELOG.md
@ -0,0 +27,4 @@
- Most MVP features implemented.
[Unreleased]: https://github.com/your-repo/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/your-repo/releases/tag/v1.0.0
2nPlusOne (Migrated from github.com) commented 2025-09-03 03:33:25 +00:00
Copy link

These URLs need to be updated

[Unreleased]: https://github.com/rit-sse/WebsiteTheSSEquel/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/rit-sse/WebsiteTheSSEquel/releases/tag/v0.1.0
These URLs need to be updated ```suggestion [Unreleased]: https://github.com/rit-sse/WebsiteTheSSEquel/compare/v0.1.0...HEAD [0.1.0]: https://github.com/rit-sse/WebsiteTheSSEquel/releases/tag/v0.1.0 ```
2nPlusOne (Migrated from github.com) reviewed 2025-09-03 03:34:51 +00:00
CONTRIBUTING.md
@ -0,0 +45,4 @@
## Code of Conduct
This project adheres to a [Code of Conduct](https://github.com/your-repo/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
2nPlusOne (Migrated from github.com) commented 2025-09-03 03:34:50 +00:00
Copy link
This project adheres to a [Code of Conduct](https://github.com/rit-sse/WebsiteTheSSEquel/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [sse-president@rit.edu].
```suggestion This project adheres to a [Code of Conduct](https://github.com/rit-sse/WebsiteTheSSEquel/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [sse-president@rit.edu]. ```
2nPlusOne (Migrated from github.com) reviewed 2025-09-03 03:37:17 +00:00
documentation/VisionAndScope.md
@ -0,0 +39,4 @@
| ID | Stakeholder Name | Role/Title | Interest in Project | Power | Communication Requirements | Engagement Strategy |
| :---- | :---- | :---- | :---- | :---- | :---- | :---- |
| S1 | Tess Hacker | Tech Head | Project leadership, quality | High | Weekly status updates | Leadership, close collaboration, technical support |
2nPlusOne (Migrated from github.com) commented 2025-09-03 03:37:17 +00:00
Copy link
| S1 | Jetmon Deng | Tech Head | Project leadership, quality | High | Weekly status updates | Leadership, close collaboration, technical support |
```suggestion | S1 | Jetmon Deng | Tech Head | Project leadership, quality | High | Weekly status updates | Leadership, close collaboration, technical support | ```
Phoenixxo (Migrated from github.com) reviewed 2025-10-05 20:35:47 +00:00
CHANGELOG.md
@ -0,0 +27,4 @@
- Most MVP features implemented.
[Unreleased]: https://github.com/your-repo/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/your-repo/releases/tag/v1.0.0
Phoenixxo (Migrated from github.com) commented 2025-10-05 20:35:47 +00:00
Copy link

v1.0.0 tag does not exist

v1.0.0 tag does not exist
Phoenixxo (Migrated from github.com) reviewed 2025-10-06 20:43:39 +00:00
CONTRIBUTING.md
@ -0,0 +45,4 @@
## Code of Conduct
This project adheres to a [Code of Conduct](https://github.com/your-repo/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
Phoenixxo (Migrated from github.com) commented 2025-10-06 20:43:38 +00:00
Copy link

Code of conduct has not been created / not in the root of the repo

Code of conduct has not been created / not in the root of the repo
Phoenixxo (Migrated from github.com) reviewed 2025-10-06 20:43:48 +00:00
documentation/VisionAndScope.md
@ -0,0 +39,4 @@
| ID | Stakeholder Name | Role/Title | Interest in Project | Power | Communication Requirements | Engagement Strategy |
| :---- | :---- | :---- | :---- | :---- | :---- | :---- |
| S1 | Tess Hacker | Tech Head | Project leadership, quality | High | Weekly status updates | Leadership, close collaboration, technical support |
Phoenixxo (Migrated from github.com) commented 2025-10-06 20:43:48 +00:00
Copy link

Looks good

Looks good
Phoenixxo (Migrated from github.com) reviewed 2025-10-06 20:45:02 +00:00
CONTRIBUTING.md
@ -0,0 +45,4 @@
## Code of Conduct
This project adheres to a [Code of Conduct](https://github.com/your-repo/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
Phoenixxo (Migrated from github.com) commented 2025-10-06 20:45:02 +00:00
Copy link

Code of conduct has not been created / not in the root of the repo

Nevermind, I see the changes now, ignore this

> Code of conduct has not been created / not in the root of the repo Nevermind, I see the changes now, ignore this
Phoenixxo (Migrated from github.com) reviewed 2025-10-06 20:45:57 +00:00
CONTRIBUTING.md
@ -0,0 +45,4 @@
## Code of Conduct
This project adheres to a [Code of Conduct](https://github.com/your-repo/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
Phoenixxo (Migrated from github.com) commented 2025-10-06 20:45:57 +00:00
Copy link

Looks good

Looks good
Phoenixxo (Migrated from github.com) approved these changes 2025-10-06 20:46:28 +00:00
Phoenixxo (Migrated from github.com) left a comment
Copy link

Everything should be good

Everything should be good
pybash (Migrated from github.com) reviewed 2025-10-07 15:06:06 +00:00
documentation/VisionAndScope.md
@ -0,0 +39,4 @@
| ID | Stakeholder Name | Role/Title | Interest in Project | Power | Communication Requirements | Engagement Strategy |
| :---- | :---- | :---- | :---- | :---- | :---- | :---- |
| S1 | Tess Hacker | Tech Head | Project leadership, quality | High | Weekly status updates | Leadership, close collaboration, technical support |
pybash (Migrated from github.com) commented 2025-10-07 15:06:06 +00:00
Copy link

Looks good to me!

Looks good to me!
pybash (Migrated from github.com) reviewed 2025-10-07 15:09:00 +00:00
CONTRIBUTING.md
@ -0,0 +45,4 @@
## Code of Conduct
This project adheres to a [Code of Conduct](https://github.com/your-repo/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [email@example.com].
pybash (Migrated from github.com) commented 2025-10-07 15:09:00 +00:00
Copy link

Looked through the code of conduct, looks good!

Looked through the code of conduct, looks good!
pybash commented 2025-10-07 15:56:31 +00:00 (Migrated from github.com)
Copy link

LGTM! 🚀

LGTM! 🚀
Sign in to join this conversation.
Reviewers
No reviewers
Phoenixxo
Labels
Clear labels   
accessibility
Accessibility improvements

  
api

   
auth.js
Issues involving Auth.js authentication

  
backend

   
copy
Writing tasks

  
database

   
defect
Something is not as it should be

  
dependencies

   
design
Task related to UI/UX wireframing and style

  
discussion

   
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
epic
Track a larger initiative made up of stories

  
feature

   
front-end

   
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
next.js
Issues involving Next.js

  
noscript
Related to noscript / no-JS fallback support

  
on hold
This is being put on hold for now...

  
operations

   
optimization

   
postgresql
Issues involving PostgreSQL

  
prisma
Issues involving the Prisma ORM

  
prototype
Creating spike deliverables or prototypes

  
question
Further information is requested

  
react
Issue involving react

  
spike
Learning material

  
stale
This is old and should be reviewed for closure.

  
story
Track a user-facing or system-facing story

  
tailwind
Issues involving Tailwind CSS

  
vulnerability
Addressing a security vulnerability

  
wontfix
This will not be worked on

No labels
accessibility
api
auth.js
backend
copy
database
defect
dependencies
design
discussion
documentation
duplicate
enhancement
epic
feature
front-end
good first issue
help wanted
invalid
next.js
noscript
on hold
operations
optimization
postgresql
prisma
prototype
question
react
spike
stale
story
tailwind
vulnerability
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
SSE/WebsiteTheSSEquel!207
No description provided.