open-sauced / intro

Empowering Your Open Source Journey: From First Contribution to Project Leadership
https://opensauced.pizza/learn
Other
497 stars 96 forks source link

Bug #107 - added spaces and adjusted headings #108

Closed asaki222 closed 5 months ago

asaki222 commented 5 months ago

Description

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

Related Tickets & Documents

Fixes #107

Mobile & Desktop Screenshots/Recordings

Updated 'How to Contribute to Documentation Heading'

Screenshot 2024-01-16 at 3 28 41 PM

Updated 'Ways to use Blogging as a Open Source Contribution'

Screenshot 2024-01-16 at 3 29 57 PM

Updated 'Examples of documentation contributions'

Screenshot 2024-01-16 at 3 31 28 PM

Steps to QA

  1. Run the project locally
  2. Navigate to this page

Added to documentation?

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

N/A

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

netlify[bot] commented 5 months ago

Deploy Preview for sauced-intro ready!

Name Link
Latest commit 2ad7db6eac4cdce5338a28053a68ad2d90cae50d
Latest deploy log https://app.netlify.com/sites/sauced-intro/deploys/65a6e86f9aa7f20008dc6eae
Deploy Preview https://deploy-preview-108--sauced-intro.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

asaki222 commented 5 months ago

Hey @asaki222,

Thank you so much for the PR! 🙌

Before I review this, can you please:

  1. Include the checklist boxes in the issue within the "Description" as per request on the issue.
  2. Write more descriptive descriptions. For example: Adjusting heading based on the issue detail --> This PR adjusts headings by (what did you do here) and adds a blank line (more details). The description should be clear and detailed so that the reviewer/maintainer can understand the changes made in your PR just by reading it. This would save us time to review your PR.
  3. Complete the PR form. I see that you link the issue in the "Description". But please fill it in the "Related Tickets & Documents" section and use "fixes" prefix (e.g.: fixes #000) to refer to the issue. You can read this resource to know more about it. FYI, many projects have this section on their PR forms. So you want to habitually fill in the form properly.

Please let me know if you have any questions. Thanks!

I updated the pr description! Let me know if I need to make any additional changes