You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-48Lines changed: 15 additions & 48 deletions
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,11 @@
2
2
3
3
Thank you for your interest in contributing to Create WordPress Project.
4
4
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.
8
6
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.
11
8
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.
14
10
15
11
## New Contributor Guide
16
12
@@ -28,70 +24,41 @@ Here are some resources to help you get started with open source contributions:
28
24
29
25
#### Create a New Issue
30
26
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).
33
28
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).
36
30
37
31
#### Solve an Issue
38
32
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.
42
34
43
35
### Making Changes
44
36
45
37
#### Branching Workflow
46
38
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.
52
40
53
41
#### Commit Your Update
54
42
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.
61
44
62
45
#### Pull Request
63
46
64
47
When you're finished with the changes, create a pull request, also known as a PR.
65
48
66
49
- 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)
- 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.
85
55
86
56
#### Your PR is Merged!
87
57
88
58
Congratulations! The Alley team thanks you.
89
59
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.
93
61
94
62
## References
95
63
96
-
This contributing guide was based in part off of the
This contributing guide was based in part off of the [GitHub Docs Contributing Guide](https://raw.githubusercontent.com/github/docs/main/CONTRIBUTING.md).
0 commit comments