Skip to content

Commit

Permalink
update readme.md and contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuadavidnelson committed Dec 14, 2023
1 parent fe57b2a commit 1293a46
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 8 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Activating Disable Blog does the following:

If Settings > Reading > Front Page Displays is not set to show on a page, then some aspects of the plugin won't work, be sure to set your front page to a static page.

#### FAQ
## FAQ

1. Can I Disable Comments?
- Other post types (like Pages) may have comment support and other great plugins exist that can disable comments, so this feature was not part of the initial development of this plugin. A future release will include options to disable comments, but until then if you would like to disable comments, try the [Disable Comments](https://wordpress.org/plugins/disable-comments/) plugin.
Expand All @@ -92,10 +92,33 @@ If Settings > Reading > Front Page Displays is not set to show on a page, then s
3. How can I disable author archives?
- If you're not using the built-in WP author archives for other purposes (example url: `example.com/author/author-name`) and would like to disable them entirely, add the following to your theme functions.php file or a custom plugin file: `add_filter( 'dwpb_disable_author_archives', '__return_true' );`. If author archives are not disabled, the plugin adds functionality to support custom post types on author archives by passing an array of post type slugs to `dwpb_author_archive_post_types` filter - however, theme support is usually needed to disable custom content types correctly.

#### Support
## Support

This plugin is maintained for free but **please reach out** and I will assist you as soon as possible. You can visit the [WordPress.org support forums](https://wordpress.org/support/plugin/disable-blog/) or create an [issue](https://github.com/joshuadavidnelson/disable-blog/issues/) on the [GitHub repository](https://github.com/joshuadavidnelson/disable-blog/).

#### Contributing
## Contributing

All contributions are welcomed and considered, please refer to [contributing.md](contributing.md).

### Pull requests
All pull requests should be directed at the `develop` branch, and will be reviewed prior to merging. No pull requests will be merged with failing tests, but it's okay if you don't initially pass tests. Please create a draft pull request for proof of concept code or changes you'd like to have input on prior to review.

Please make on a branch specific to a single issue or feature. For instance, if you are suggest a solution to an issue, please create fork with a branch like `issue-894`. Or if you are proposing a new feature, create a fork with the branch name indicating the feature like `feature-example-bananas`

All improvements are merged into `develop` and then queued up for release before being merged into `stable`. Releases are deployed via github actions to wordpress.org on tagging a new release.

### Main Branches

The `stable` branch is reserved for releases and intended to be a mirror of the official current release, or `trunk` on wordpress.org.

The `develop` branch is the most current working branch. _Please direct all pull requests to the `develop` branch_

### Developing Disable Blog Locally

**Requirements:**
- Docker
- Node Package Manager (npm)

This repo contains the files needed to boot up a local development environment using [wp-env](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/).

Run `npm install` and the `npm run env:start` to boot up a local environment.
23 changes: 18 additions & 5 deletions contributing.md
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!

0 comments on commit 1293a46

Please sign in to comment.