Skip to content

Commit e4548a6

Browse files
committed
fix: remove extra newline in blog post excerpts for consistency
1 parent 81b0547 commit e4548a6

File tree

117 files changed

+841
-842
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+841
-842
lines changed

blog/2023/2023-04-17-writing-your-first-pull-request-tips-best-practices-and-ai-powered-tools-for-success.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,36 @@ description: "If you're new to contributing to open-source projects, submitting
77
image: https://media.dev.to/cdn-cgi/image/width=1000,height=420,fit=cover,gravity=auto,format=auto/https%3A%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Farticles%2F4xtz1foaoswl7f55hzgk.png
88
---
99

10-
I don’t remember writing my first Pull Request (PR), and to be honest, I actually looked to see if I could find it for this post, but I know that I was really nervous because I wasn’t sure if I was doing it “right.” I think I actually spent more time worrying about it than I did actually writing the thing. The good news is that there isn’t really a right way to write a PR, but there are some best practices that can guide your writing and help the maintainer to be able to understand the changes.
10+
I don’t remember writing my first Pull Request (PR), and to be honest, I actually looked to see if I could find it for this post, but I know that I was really nervous because I wasn’t sure if I was doing it “right.” I think I actually spent more time worrying about it than I did actually writing the thing. The good news is that there isn’t really a right way to write a PR, but there are some best practices that can guide your writing and help the maintainer to be able to understand the changes.
1111

1212
<!-- truncate -->
1313

1414
## Review the Contribution Guidelines
15+
1516
Maintainers want to help you write your PR; that’s why they often outline contributing directions in their repositories.
1617

1718
![Jerry McGuire “Help me, help you gif”](https://media.giphy.com/media/uRb2p09vY8lEs/giphy.gif)
1819

19-
This file—often called CONTRIBUTING.md—gives guidelines for submitting your PR, including information like whether or not you need to write tests, the communication process, coding style, and how to submit your pull request. Check out [OpenSauced’s Contributing Guide](https://opensauced.pizza/docs/contributing/introduction-to-contributing/), as an example.
20+
This file—often called CONTRIBUTING.md—gives guidelines for submitting your PR, including information like whether or not you need to write tests, the communication process, coding style, and how to submit your pull request. Check out [OpenSauced’s Contributing Guide](https://opensauced.pizza/docs/contributing/introduction-to-contributing/), as an example.
2021

2122
## Tips for Your First PR
23+
2224
Although every repository may have unique guidelines, there are general guidelines for all PRs. Here are some tips to keep in mind:
2325

2426
### Create a Clear Title
25-
The title should give an indication of the issue, the changes made, and the type of PR–is this a bug fix, content or documentation change, new feature, or something else?
27+
28+
The title should give an indication of the issue, the changes made, and the type of PR–is this a bug fix, content or documentation change, new feature, or something else?
2629

2730
![OpenSauced title examples](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/yv10emgx8a7grxyovbew.png)
2831
<small> OpenSauced’s CONTRIBUTING guidelines for titles</small>
2932

30-
3133
### Give a Detailed Description
32-
PRs often include a summary of the changes, as well as any relevant context or background information that might be helpful in understanding the proposed changes.
34+
35+
PRs often include a summary of the changes, as well as any relevant context or background information that might be helpful in understanding the proposed changes.
3336

3437
### Provide context
35-
A well-written description will help the maintainer understand the purpose of the PR, the changes you’ve made, and why the changes were made. Here are some of the reasons the description is key to the success of the PR:
38+
39+
A well-written description will help the maintainer understand the purpose of the PR, the changes you’ve made, and why the changes were made. Here are some of the reasons the description is key to the success of the PR:
3640

3741
1. Facilitates collaboration. More details allow team members to share their feedback, identify potential issues, and ask questions. With open and transparent communication, a sense of community and trust among team members develops, leading to better collaboration.
3842

@@ -43,23 +47,26 @@ A well-written description will help the maintainer understand the purpose of th
4347
![OpenSauced's Examples for communication style](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/sc4v1pihnggpq0asu671.png)
4448
<small> OpenSauced’s [CONTRIBUTING guidelines for communication style](https://opensauced.pizza/docs/contributing/introduction-to-contributing/) </small>
4549

46-
### Link the issue
47-
If the PR is related to an issue, you can link that issue and automatically close the issue when the PR is merged. One way to do this is to use this syntax: `closes #issue-number` for example, `closes #11`.
50+
### Link the issue
51+
52+
If the PR is related to an issue, you can link that issue and automatically close the issue when the PR is merged. One way to do this is to use this syntax: `closes #issue-number` for example, `closes #11`.
53+
54+
### Acknowledge Requirements
4855

49-
### Acknowledge Requirements
5056
If there are requirements for new code to be merged in, like writing tests or documentation, you should also include that information in the PR. Other steps might include running current tests before submitting, agreeing to the Code of Conduct, and checking to make sure there’s not an open issue or another PR addressing the same problem you’ve fixed.
5157

52-
### Add a Gif!
58+
### Add a Gif
59+
5360
If you want to know why, check out my last post, [How to Create a Good Pull Request Template (and Why You Should Add Gifs)](https://dev.to/opensauced/how-to-create-a-good-pull-request-template-and-why-you-should-add-gifs-4i0l)
5461

5562
## Bonus Level: Power Up Your PRs with AI
5663

5764
If you want to take your PRs to the next level, sign up for [GitHub’s Copilot for Pull Requests](https://githubnext.com/projects/copilot-for-pull-requests) waitlist! Copilot for PRs can give a summary of the changes, a detailed list with code references, or even create a poem 🤯
5865

5966
## Community Shoutout
60-
For a great example from one of our community members, @nickytonline, check out [this PR](https://insights.opensauced.pizza/feed/99).
67+
68+
For a great example from one of our community members, @nickytonline, check out [this PR](https://insights.opensauced.pizza/feed/99).
6169

6270
![gif of Nick Taylor’s PR](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/i19g7u3uwqzjf3exvbal.gif)
6371

6472
If you’re looking for an open source project to submit your first PR to, find a project that’s well documented, aligns with your interests and skills, and is accepting PRs from new contributors. Check out [OpenSauced’s Hot Repositories](https://hot.opensauced.pizza/) or [Insights](https://insights.opensauced.pizza) to find popular repositories and explore based on your favorite topics. And if you want to see your PR mentioned by OpenSauced, be sure to add it to your [highlights](https://insights.opensauced.pizza/feed)!
65-

blog/2023/2023-04-20-how-vercel-is-using-github-discussions-to-build-a-strong-nextjs-community.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,31 @@ Communication is key to maintaining a healthy open source project. It’s even m
1111
<!-- truncate -->
1212

1313
## What is Next.js?
14+
>
1415
> Next.js is a flexible React framework that gives you building blocks to create fast web applications.
1516
1617
Vercel, the company behind Next.js, provides a platform for deploying and hosting Next.js applications, as well as a range of other tools and services for building and scaling web applications.
1718

1819
## How does Next.js use their discussions?
20+
1921
At first glance, the list of discussion features for Next.js looks pretty ordinary, well except maybe the squirrel with the hat as the icon for the Show and Tell section. Next.js takes it a step further and leverages GitHub discussions to provide its community with a space for participation and interaction. The project prioritizes community building by pinning important discussions at the top of the page: Companies/Sites using Next.js, Who’s hiring (April 2023), Who wants to be hired (April 2023).
2022

2123
### Companies/Sites using Next.js
24+
2225
This discussion lists companies that are using Next.js, allows folks to respond to the post with their site that’s built with Next.js, and also links to their [showcase](https://nextjs.org/showcase) as well. So if you have a Next.js site, and you’re not already showing it off, add it to [this discussion](https://github.com/vercel/next.js/discussions/10640)!
2326

24-
### Who’s hiring
27+
### Who’s hiring
28+
2529
This monthly post provides a space for companies to advertise job openings for individuals with Next.js experience, and for job seekers to find opportunities. I checked out their posts all the way back to November 2021, and loved seeing how many included this line: “At least one company has hired someone as a result of it!”
2630

2731
[https://twitter.com/nutlope/status/1610667757565083648?s=20](https://twitter.com/nutlope/status/1610667757565083648?s=20)
2832

29-
30-
### Who wants to be hired
33+
### Who wants to be hired
3134

3235
This pinned post is for job seekers with Next.js experience to showcase their skills and experience. Companies looking to hire can browse the post for potential candidates. This gives a nice glimpse into the Next.js community and provides support for job seekers and does my favorite thing: offers to send swag to anyone who was hired through the post.
3336

3437
![Screenshot of Who wants to be hired (April 2023) post](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/ug608pczuotc58ag8i6f.png)
3538

3639
It’s great to see Next.js building a strong and supportive community through discussions. If you’re a Next.js developer looking for work and you have contributions you’d like to highlight, you can add them to your [OpenSauced highlights](https://insights.opensauced.pizza/feed) and link them to your post.
3740

38-
3941
<small>header image created using [midjourney](https://www.midjourney.com/app/jobs/53c570b9-3cc2-48c5-9fe0-8d855cfbeb34/).</small>

blog/2023/2023-04-24-managing-community-health-files-and-templates-with-a-github-repository.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ I collect open source projects like some people collect discord servers. To be a
1111
<!-- truncate -->
1212

1313
## What is a `.github` Repo?
14-
A `.github` repository is a special type of repository in GitHub that allows maintainers to store community health files and templates for their projects.
1514

16-
> Community Health files promote the well-being of the community and focus on communication, documentation, supporting members through a code of conduct, and community recognition.
15+
A `.github` repository is a special type of repository in GitHub that allows maintainers to store community health files and templates for their projects.
1716

18-
The `.github` repository–found at `https://github.com/<username/organization>/.github`- can house the community health files for your organization as the default files. According to [GitHub](https://github.blog/changelog/2019-02-21-organization-wide-community-health-files/), “While the file itself won’t appear in the file browser or Git history for each repository, it will be surfaced throughout developers’ workflows, such as when opening a new issue or when viewing the Community Profile, just as if it were committed to the repository directly.”
17+
> Community Health files promote the well-being of the community and focus on communication, documentation, supporting members through a code of conduct, and community recognition.
1918
19+
The `.github` repository–found at `https://github.com/<username/organization>/.github`- can house the community health files for your organization as the default files. According to [GitHub](https://github.blog/changelog/2019-02-21-organization-wide-community-health-files/), “While the file itself won’t appear in the file browser or Git history for each repository, it will be surfaced throughout developers’ workflows, such as when opening a new issue or when viewing the Community Profile, just as if it were committed to the repository directly.”
2020

2121
![Screenshot of the open-sauced/.github repo](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/i41566ytubxwkz60kjh7.png)
2222

@@ -34,4 +34,4 @@ Once you have added your PR template, click the "Commit new file" button to save
3434

3535
When creating a PR template, keep in mind that the template is easy to read and understand. Remember, the template is supposed to make things easier for you and the contributors. What information do you need to be able to review the PR more efficiently? What information can guide a new contributor through writing a PR for the first time?
3636

37-
Finally, the beauty of using one template for all your repositories is that if you decide to update it, you only need to do that in one location. As your project evolves and new requirements emerge, you may find that the template needs to be revised or you might feedback from contributors and other maintainers, and make changes as needed to ensure that the PR template remains effective and useful. If you're interested in more content on PRs, check out [Writing Your First Pull Request: Tips, Best Practices, and AI-Powered Tools for Success](https://dev.to/opensauced/writing-your-first-pull-request-tips-best-practices-and-ai-powered-tools-for-success-3bg9) and [How to Create a Good Pull Request Template (and Why You Should Add Gifs)](https://dev.to/opensauced/how-to-create-a-good-pull-request-template-and-why-you-should-add-gifs-4i0l).
37+
Finally, the beauty of using one template for all your repositories is that if you decide to update it, you only need to do that in one location. As your project evolves and new requirements emerge, you may find that the template needs to be revised or you might feedback from contributors and other maintainers, and make changes as needed to ensure that the PR template remains effective and useful. If you're interested in more content on PRs, check out [Writing Your First Pull Request: Tips, Best Practices, and AI-Powered Tools for Success](https://dev.to/opensauced/writing-your-first-pull-request-tips-best-practices-and-ai-powered-tools-for-success-3bg9) and [How to Create a Good Pull Request Template (and Why You Should Add Gifs)](https://dev.to/opensauced/how-to-create-a-good-pull-request-template-and-why-you-should-add-gifs-4i0l).

0 commit comments

Comments
 (0)