Problem/Motivation

We need documentation to onboard people to the Starshot Demo Design System project.

This issue is focused on the merge request guide.

Steps to reproduce

Proposed resolution

Although there are existing docs, let's make this simpler for people with step-by-step for:

  • Creating a merge request
  • Contributing to merge requests

Remaining tasks

  • Gather info and links
  • Create draft in Google docs
  • Port to community initiative guides

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#6 Screen Shot 2024-08-07 at 4.35.39 PM.png114.91 KBsiramsay

Comments

Kristen Pol created an issue. See original summary.

kristen pol’s picture

kristen pol’s picture

Note that Jacob has reviewed and suggesting moving the merge request creation to after the code changes which is a good idea so will do that tomorrow probably.

kristen pol’s picture

Some other feedback from Jacob:

1. Quotes need fixing.

 git commit -m “Added tag SDC yml file.”

2. He didn't see the yellow merge request number because the pipeline was running so update doc to reflect this.

3. It wasn't clear to him how to change the status, assigned, etc.

siramsay’s picture

StatusFileSize
new114.91 KB

Step 2
2. Find the issue where you want to contribute code [example issue]

Example issue is a fixed issue and doesn't have Create issue fork

kristen pol’s picture

Thanks. I was just pointing at an issue that was used for this type of work… I used it when creating the documentation… perhaps I’ll remove the link to avoid confusion

kristen pol’s picture

Assigned: Unassigned » kristen pol

Assigning back to me but this is still being reviewed by others so will hold off on changes for now.

siramsay’s picture

I think removing link is best. For someone new/beginner, it can be confusing. I've been there.

sea2709’s picture

I haven't contributed to merge requests before. Is there a sample issue that I can do some trials? I read through the guide and got the ideas, just want to do it by myself!

kristen pol’s picture

Status: Needs review » Needs work

Thanks @siramsay. Will do!

@sea2709 Let me find or create an issue for you to test this out :)

Moving this back to needs work for me to make changes.

kristen pol’s picture

kristen pol’s picture

I have made all the changes above except for reordering when you create the MR. I'll wait on @sea2709's feedback before doing that.

kristen pol’s picture

Status: Needs work » Needs review

Back to needs review.

kristen pol’s picture

@sea2709 Did you have any additional feedback based on the MR you did?

sea2709’s picture

@Kristen: I just have only one comment, I think step 6 should be placed after step 15 (or at least, that is what I did). After I push changes, I will be able to create a MR.

kristen pol’s picture

Status: Needs review » Needs work

@sea2709 Gotcha. So just the reordering of MR creation that Jacob also pointed out. I'll move back to needs work for reworking that.

kristen pol’s picture

Assigned: kristen pol » Unassigned

@sea2709 Would you have time to rework the guide so the MR is created after the code branch is created and changes are added?

We've been doing that but I haven't had time to update the docs.

kristen pol’s picture

Status: Needs work » Fixed

Going to call this one fixed for now. If someone wants to update to not do the draft MR, just reopen and update the docs.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.