Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[VNV PLAN] Address Feedback #280

Open
7 tasks
Sevhena opened this issue Nov 29, 2024 · 0 comments
Open
7 tasks

[VNV PLAN] Address Feedback #280

Sevhena opened this issue Nov 29, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation vnv-plan Related to the VnV Plan (Deliverable 4)

Comments

@Sevhena
Copy link
Collaborator

Sevhena commented Nov 29, 2024

Important Notes!!

When making changes to documentation, we need to keep track of the changes we make. You've probably noticed in the sample documents we've referenced that they have red text to show their changes. This is a rubric component. We could do that but we could also make it simpler and remove the need for red text in our documents. If you follow exactly the steps listed below we can just use version control to track our changes!!

  • Make sure to reference the issue in the commits. Each commit should have changes related to a single issue
  • When you make changes, make note of them in the revision table at the beginning of the document
  • If the feedback mentioned in the issue will not be fixed, need to explain why before closing issue (important, again rubric component)

p.s. if you forget to link the number of the issue (but please don't) then just copy the SHA id of the commit and paste it as a comment in the issue the commit is for. That will manually create a link between the commit and the issue.

The branching strategy will be 1 branch per document. A PR will be merged once all issues in the epic (this one) are addressed. You can view the branch name below or in the Development section in the sidebar.

branch name for this epic: vnvp-feedback

I've attached pictures of the feedback from the rubric, but feel free to check the feedback on avenue if more context is needed.

Peer Review Feedback

TA Feedback

@Sevhena Sevhena added documentation Improvements or additions to documentation vnv-plan Related to the VnV Plan (Deliverable 4) labels Nov 29, 2024
@Sevhena Sevhena moved this to Todo in SCO - Project Board Nov 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation vnv-plan Related to the VnV Plan (Deliverable 4)
Projects
Status: Todo
Development

When branches are created from issues, their pull requests are automatically linked.

5 participants