Skip to content

Commit 3c9dfb6

Browse files
Flesh out language in the Contributing section
1 parent bc3f2a2 commit 3c9dfb6

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,31 @@ Once you've done so, you can install this package with `wp package install runco
5656

5757
## Contributing
5858

59-
Code and ideas are more than welcome.
59+
We appreciate you taking the initiative to contribute to this project.
6060

61-
Please [open an issue](https://github.com/runcommand/dist-archive/issues) with questions, feedback, and violent dissent. Pull requests are expected to include test coverage.
61+
Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
62+
63+
### Reporting a bug
64+
65+
Think you’ve found a bug? We’d love for you to help us get it fixed.
66+
67+
Before you create a new issue, you should [search existing issues](https://github.com/runcommand/dist-archive/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
68+
69+
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/runcommand/dist-archive/issues/new) with the following:
70+
71+
1. What you were doing (e.g. "When I run `wp post list`").
72+
2. What you saw (e.g. "I see a fatal about a class being undefined.").
73+
3. What you expected to see (e.g. "I expected to see the list of posts.")
74+
75+
Include as much detail as you can, and clear steps to reproduce if possible.
76+
77+
### Creating a pull request
78+
79+
Want to contribute a new feature? Please first [open a new issue](https://github.com/runcommand/dist-archive/issues/new) to discuss whether the feature is a good fit for the project.
80+
81+
Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
82+
83+
1. Create a feature branch for each contribution.
84+
2. Submit your pull request early for feedback.
85+
3. Include functional tests with your changes. [Read the WP-CLI documentation](https://wp-cli.org/docs/pull-requests/#functional-tests) for an introduction.
86+
4. Follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).

0 commit comments

Comments
 (0)