Skip to content

Commit 0401b15

Browse files
Merge pull request #11 from runcommand/update-contributing
Update contributing section for README.md
2 parents b59bf72 + 05213be commit 0401b15

File tree

2 files changed

+9
-25
lines changed

2 files changed

+9
-25
lines changed

README.md

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,32 +58,11 @@ Once you've done so, you can install this package with `wp package install runco
5858

5959
We appreciate you taking the initiative to contribute to this project.
6060

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.
61+
Think you’ve found a bug? Before you create a new issue, you should [search existing issues](https://github.com/{package_name}/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. 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/{package_name}/issues/new) with description of what you were doing, what you saw, and what you expected to see.
6262

63-
### Reporting a bug
63+
Want to contribute a new feature? Please first [open a new issue](https://github.com/{package_name}/issues/new) to discuss whether the feature is a good fit for the project. Once you've decided to work on a pull request, please include [functional tests](https://wp-cli.org/docs/pull-requests/#functional-tests) and follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
6464

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/).
65+
Github issues are meant for tracking bugs and enhancements. For general support, email [[email protected]](mailto:[email protected]).
8766

8867

8968
*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

composer.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@
2121
"extras": {
2222
"commands": [
2323
"dist-archive"
24-
]
24+
],
25+
"readme": {
26+
"contributing": {
27+
"body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/contributing-open-source.md"
28+
}
29+
}
2530
}
2631
}

0 commit comments

Comments
 (0)