Skip to content

Commit 1670bff

Browse files
committed
Remove extraneous line breaks from markdown files
1 parent c13cd73 commit 1670bff

File tree

2 files changed

+16
-50
lines changed

2 files changed

+16
-50
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,11 @@
22

33
Thank you for your interest in contributing to Create WordPress Project.
44

5-
Read our
6-
[Code of Conduct](https://github.com/alleyinteractive/.github/blob/main/CODE_OF_CONDUCT.md)
7-
to keep our community approachable and respectable.
5+
Read our [Code of Conduct](https://github.com/alleyinteractive/.github/blob/main/CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
86

9-
In this guide you will get an overview of the contribution workflow from opening
10-
an issue, creating a PR, reviewing, and merging the PR.
7+
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
118

12-
Use the table of contents icon on the top left corner of this document to get to
13-
a specific section of this guide quickly.
9+
Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
1410

1511
## New Contributor Guide
1612

@@ -28,70 +24,41 @@ Here are some resources to help you get started with open source contributions:
2824

2925
#### Create a New Issue
3026

31-
If you see a problem or an opportunity to create a new feature,
32-
[search if an issue already exists](https://github.com/alleyinteractive/create-wordpress-project/issues).
27+
If you see a problem or an opportunity to create a new feature, [search if an issue already exists](https://github.com/alleyinteractive/create-wordpress-project/issues).
3328

34-
If a related issue doesn't exist, you can
35-
[open a new issue](https://github.com/alleyinteractive/create-wordpress-project/issues/new).
29+
If a related issue doesn't exist, you can [open a new issue](https://github.com/alleyinteractive/create-wordpress-project/issues/new).
3630

3731
#### Solve an Issue
3832

39-
If you would like to help solve an existing issue navigate to the
40-
[list of open issues](https://github.com/alleyinteractive/create-wordpress-project/issues)
41-
and choose one that interests you.
33+
If you would like to help solve an existing issue navigate to the [list of open issues](https://github.com/alleyinteractive/create-wordpress-project/issues) and choose one that interests you.
4234

4335
### Making Changes
4436

4537
#### Branching Workflow
4638

47-
If you are a member of Alley, you can create a new feature branch in this repo
48-
according to our branch naming conventions. If you are not a member of Alley,
49-
you should first fork this repository, then make your changes in a branch on
50-
your fork. In either case, once you have completed your changes, create a pull
51-
request against the `develop` branch of this repository.
39+
If you are a member of Alley, you can create a new feature branch in this repo according to our branch naming conventions. If you are not a member of Alley, you should first fork this repository, then make your changes in a branch on your fork. In either case, once you have completed your changes, create a pull request against the `develop` branch of this repository.
5240

5341
#### Commit Your Update
5442

55-
Commit the changes once you are happy with them. Once your changes are ready,
56-
don't forget to self-review to speed up the review process. The self-review
57-
should ensure that all automated tests and linting checks pass. See the
58-
[GitHub Workflows directory](.github/workflows) for a list of all automated
59-
tests that are executed when a PR is created and ensure that they pass locally
60-
before creating your PR.
43+
Commit the changes once you are happy with them. Once your changes are ready, don't forget to self-review to speed up the review process. The self-review should ensure that all automated tests and linting checks pass. See the [GitHub Workflows directory](.github/workflows) for a list of all automated tests that are executed when a PR is created and ensure that they pass locally before creating your PR.
6144

6245
#### Pull Request
6346

6447
When you're finished with the changes, create a pull request, also known as a PR.
6548

6649
- Add a description of what the change does.
67-
- Don't forget to
68-
[link your PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
69-
if you are solving one.
70-
- Enable the checkbox to
71-
[allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
72-
so the branch can be updated for a merge. Once you submit your PR, an Alley
73-
team member will review your proposal. We may ask questions or request
74-
additional information.
75-
- We may ask for changes to be made before a PR can be merged, either using
76-
[suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)
77-
or pull request comments. You can apply suggested changes directly through the
78-
UI. You can make any other changes in your fork, then commit them to your
79-
branch.
80-
- As you update your PR and apply changes, mark each conversation as
81-
[resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
82-
- If you run into any merge issues, check out this
83-
[git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you
84-
resolve merge conflicts and other issues.
50+
- Don't forget to [link your PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
51+
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. Once you submit your PR, an Alley team member will review your proposal. We may ask questions or request additional information.
52+
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
53+
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
54+
- If you run into any merge issues, check out this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
8555

8656
#### Your PR is Merged!
8757

8858
Congratulations! The Alley team thanks you.
8959

90-
Once your PR is merged, your contributions will be publicly available on the
91-
`develop` branch of the project, included in a future tagged version, and you will
92-
be added to the contributors list.
60+
Once your PR is merged, your contributions will be publicly available on the `develop` branch of the project, included in a future tagged version, and you will be added to the contributors list.
9361

9462
## References
9563

96-
This contributing guide was based in part off of the
97-
[GitHub Docs Contributing Guide](https://raw.githubusercontent.com/github/docs/main/CONTRIBUTING.md).
64+
This contributing guide was based in part off of the [GitHub Docs Contributing Guide](https://raw.githubusercontent.com/github/docs/main/CONTRIBUTING.md).

CONTRIBUTORS.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,4 @@ A heartfelt thank you to everyone who made this project possible:
1717
- Viktor Szépe ([@szepeviktor](https://github.com/szepeviktor))
1818
- Travis Weston ([@anubisthejackle](https://github.com/anubisthejackle))
1919

20-
If you are interested in contributing, please read our
21-
[contributing guidelines](CONTRIBUTING.md).
20+
If you are interested in contributing, please read our [contributing guidelines](CONTRIBUTING.md).

0 commit comments

Comments
 (0)