Skip to content

Commit

Permalink
Clean up READMEs, add contribution notes, split changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jdevalk committed Dec 8, 2023
1 parent f4b9bcd commit 725daed
Show file tree
Hide file tree
Showing 4 changed files with 404 additions and 306 deletions.
52 changes: 52 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Contribution Guidelines

Before filing a bug report or a feature request, be sure to read the contribution guidelines.

## How to use GitHub
We use GitHub exclusively for well-documented bugs, feature requests and code contributions. Communication is always done in English.

To receive free support for Accessibility Checker we have the following channels:
* [The support pages on our site](https://my.equalizedigital.com/support/)
* [Support forums](https://wordpress.org/support/plugin/accessibility-checker/) on WordPress.org

Thanks for your understanding.

## Security issues
Please do not report security issues here. Instead, email them to security at our domain so we can deal with them securely and quickly.

## I have found a bug
Before opening a new issue, please:
* update to the newest versions of WordPress and the Accessibility Checker plugins.
* search for duplicate issues to prevent opening a duplicate issue. If there is already an open existing issue, please comment on that issue.
* follow our _New issue_ template when creating a new issue.
* add as much information as possible. For example: add screenshots, relevant links, step by step guides etc.

## I have a feature request
Before opening a new issue, please:
* search for duplicate issues to prevent opening a duplicate feature request. If there is already an open existing request, please leave a comment there.
* add as much information as possible. For example: give us a clear explanation of why you think the feature request is something we should consider for the plugin.

## I want to create a patch
Community made patches, localizations, bug reports and contributions are very welcome and help us tremendously.

When contributing please ensure you follow the guidelines below so that we can keep on top of things.

#### Submitting an issue you found
Make sure your problem does not exist as a ticket already by searching through [the existing issues](https://github.com/equalizedigital/accessibility-checker/issues). If you cannot find anything which resembles your problem, please [create a new issue](https://github.com/equalizedigital/accessibility-checker/issues/new).

#### Fixing an issue

* Fork the repository on GitHub (make sure to use the `develop` branch).
* Make the changes to your forked repository.
* Ensure you stick to the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/) and you properly document any new functions, actions and filters following the [documentation standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/).
* When committing, reference your issue and include a note about the fix.
* Push the changes to your fork and submit a pull request to the `develop` branch of the Accessibility Checker repository.

We will review your pull request and merge when everything is in order. We will help you to make sure the code complies with the standards described above.

#### 'Patch welcome' issues
Some issues are labeled 'patch-welcome'. This means we see the value in the particular enhancement being suggested but have decided for now not to prioritize it. If you however decide to write a patch for it, we'll gladly include it after some code review.

#### Additional Resources
* [General GitHub Documentation](https://help.github.com/)
* [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
[![CS](https://github.com/equalizedigital/accessibility-checker/actions/workflows/cs.yml/badge.svg)](https://github.com/equalizedigital/accessibility-checker/actions/workflows/cs.yml)
[![Lint](https://github.com/equalizedigital/accessibility-checker/actions/workflows/lint.yml/badge.svg)](https://github.com/equalizedigital/accessibility-checker/actions/workflows/lint.yml)
[![Security](https://github.com/equalizedigital/accessibility-checker/actions/workflows/security.yml/badge.svg)](https://github.com/equalizedigital/accessibility-checker/actions/workflows/security.yml)
[![Test](https://github.com/equalizedigital/accessibility-checker/actions/workflows/phpunit.yml/badge.svg)](https://github.com/equalizedigital/accessibility-checker/actions/workflows/phpunit.yml)

# Equalize Digital Accessibility Checker

## What is this?
Audit and check your website for accessibility before you hit publish. In-post accessibility scanner and guidance for WCAG compliance. No API or per page fees.

* [Plugin Website](https://equalizedigital.com/accessibility-checker/)
* [Documentation](https://equalizedigital.com/accessibility-checker/documentation/)
* [Compare Free to Pro](https://equalizedigital.com/accessibility-checker/features/#comparison)
* [Get Pro](https://equalizedigital.com/accessibility-checker/pricing/)
* [WP Accessibility Meetup](https://equalizedigital.com/wordpress-accessibility-meetup/)
* [WP Accessibility Facebook Group](https://www.facebook.com/groups/wordpress.accessibility)

## Want to contribute?

### Prerequisites
At Equalize Digital, we make use a specific toolset to develop our code. Please ensure you have the following tools installed before contributing.

* [Composer](https://getcomposer.org/)
* [NPM](https://www.npmjs.com/)

### Getting started

Check out this repository from GitHub, then run:

```shell
composer install
npm install
npm run build
```

## Support

This is a developer portal for Accessibility Checker and should not be used for support. Please visit the [support forums](https://wordpress.org/support/plugin/accessibility-checker/) for support.

## Contributions

Anyone is welcome to contribute to Accessibility Checker. Please [read the guidelines](.github/CONTRIBUTING.md) for contributing to this repository.

There are various ways you can contribute:

* [Raise an issue](https://github.com/equalizedigital/accessibility-checker/issues) on GitHub.
* Send us a Pull Request with your bug fixes and/or new features.
Loading

0 comments on commit 725daed

Please sign in to comment.