-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme.md and contributing.md
- Loading branch information
1 parent
fe57b2a
commit 1293a46
Showing
2 changed files
with
44 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,21 @@ | ||
##### Main Branches | ||
# Contributing to Disable Blog | ||
|
||
The `stable` branch is reserved for releases and intended to be a mirror of the official current release, or `trunk` on wp.org. | ||
Thank you for considering contributing to the on-going development of this plugin! All contributions are welcomed and support can come in many forms: | ||
|
||
The `develop` branch is the most current working branch. _Please direct all pull requests to `develop`_ | ||
- **Sponsoring** - [Donate](https://joshuadnelson.com/donate/) to help support plugin development hours. | ||
|
||
##### Pull requests | ||
All pull requests should be made on a branch specific to a single issue or feature, directed to the `develop` branch. All improvements are merged into `develop` and then queued up for release before being merged into `stable`. Releases are deployed via github actions to wp.org on tagging a new release. | ||
- **Bug reporting** - [Submit an issue](https://github.com/joshuadavidnelson/disable-blog/issues/) on the Github repo or [WordPress.org Support forum](https://wordpress.org/support/plugin/disable-blog/), _knowing_ about an issue is the first step to fixing it! Bug reports are a vital way to help make the plugin better for you and for others. **If you have found a security vulnerability, please [contact the developer directly](mailto:[email protected]).** | ||
|
||
- **Translations** - The effort to localize strings on the plugin is entirely a volunteer effort, and these contributions have a huge impact on the plugin's accessibility. Thank you to our translators! Learn more about how you can contribute [here](https://make.wordpress.org/polyglots/teams/). | ||
|
||
- **Documentation** - Suggest edits to our documentation, post a walkthrough on how to use or extend the plugin, or provide help to other users on the [support forums](https://wordpress.org/support/plugin/disable-blog/). | ||
|
||
- **Pull Requests** - Suggest changes to the code to enhance the plugin, see the [Pull Requests](README.md#pull-requests) section in the main readme doc. _Please direct all Pull Requests to the `develop` branch_ | ||
|
||
- **Positive Reviews** - [Adding a positive review](https://wordpress.org/support/plugin/disable-blog/reviews/#new-post) to the WordPress page helps spread the word and encourage otherts to trust our efforts. | ||
|
||
- **Testing** - Taking the time to test the plugin and report back any findings is a great help! Feel free to test [current pull requests](https://github.com/joshuadavidnelson/disable-blog/pulls/) and leave comments, or test the current version locally with the newest version of WordPress or your own plugin. We are strongly in favor of Cross Plugin Integration - being compatible with as many other plugins as possible! | ||
|
||
- **Support** - We welcome solutions and constructive responses to [support forum](https://wordpress.org/support/plugin/disable-blog/) posts. | ||
|
||
However you choose to contribute, we ask that you follow the [Code of Conduct](code-of-conduct.md) and conduct yourself in a compassionate, professional manner. Thank you again for your contributions! |