Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

docs: add "Issues and Pull Request Templates" subsection #39

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

adiati98
Copy link
Member

Description

This PR adds "Issues and Pull Request Templates" subsection to the "Maintainer Power-Ups" chapter

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Closes #37

Mobile & Desktop Screenshots/Recordings

N/A

Steps to QA

N/A

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@adiati98 adiati98 added the documentation Improvements or additions to documentation label Jan 28, 2024
@adiati98 adiati98 requested review from BekahHW and jdwilkin4 January 28, 2024 10:44
@adiati98 adiati98 self-assigned this Jan 28, 2024
@adiati98
Copy link
Member Author

adiati98 commented Feb 1, 2024

@BekahHW is the content here good enough?

@adiati98
Copy link
Member Author

adiati98 commented Feb 6, 2024

@BekahHW @jdwilkin4,

We now have more thorough explanation with GIFs for templates in PR #51. This PR will then be a repetition.

  • Do we still want to keep this PR and have this section in both "Maintainer Power Ups" and "Setting Up Your Project"? Or,
  • do we want to keep this section as current in "Setting Up Your Project"? Or
  • do we want to move the one in "Setting Up Your Project" into "Maintainer Power Ups" based on this comment?

@jdwilkin4
Copy link
Contributor

@adiati98

Bekah would probably be a better one to decide on the questions you posed

@BekahHW
Copy link
Member

BekahHW commented Feb 19, 2024

This isn't on topic here, but @adiati98 does the codeowners info need updated here?

@adiati98
Copy link
Member Author

@BekahHW yes! I'll add the asterisk and make it inline.

We need to update our CODEOWNERS files as well across repos.

@adiati98
Copy link
Member Author

Do you also have thoughts on this comment?

@BekahHW
Copy link
Member

BekahHW commented Feb 19, 2024

Do you also have thoughts on this comment?

That's what I was looking at. So I think the way this is set up now works. Does that make sense?

I think we need to think about this from a user's perspective. Ideally, they'll go through this course from start to finish. But likely, folks will skip around to find the information. Because of that, I think it's ok to have some overlapping information in both of the sections.

I know that templates aren't necessary, but I tend to think you should start a project with them. It's a light lift, and IMO is a best practice that will save them a ton of time down the road. Whereas GH actions probably aren't necessary to most small projects.

@adiati98
Copy link
Member Author

Do you also have thoughts on this comment?

That's what I was looking at. So I think the way this is set up now works. Does that make sense?

I think we need to think about this from a user's perspective. Ideally, they'll go through this course from start to finish. But likely, folks will skip around to find the information. Because of that, I think it's ok to have some overlapping information in both of the sections.

I know that templates aren't necessary, but I tend to think you should start a project with them. It's a light lift, and IMO is a best practice that will save them a ton of time down the road. Whereas GH actions probably aren't necessary to most small projects.

Now I see how we want to approach this. It's true that some folks (including me sometimes 😆) tend to jump here and there to find information rather than stick from start to finish. That does make sense. Thanks!

@adiati98 adiati98 merged commit 9431d49 into main Feb 20, 2024
@adiati98 adiati98 deleted the docs/add-templates-subsection branch February 20, 2024 08:37
@adiati98
Copy link
Member Author

This isn't on topic here, but @adiati98 does the codeowners info need updated here?

I'll fix this in the final check #42 👍

adiati98 added a commit that referenced this pull request Feb 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention Issue Forms and PR Templates
3 participants