Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 2.6 KB
Raw

Contributing to A11y Tester WordPress Plugin

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the A11y Tester WordPress Plugin, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

🌳 Code of Conduct

This project and everyone participating in it is governed by the A11y Tester Code of Conduct. By participating, you are expected to uphold this code.

🚀 Getting Started

  1. Fork the Repository: Fork the project repository to your GitHub account.
  2. Clone the Fork: Clone the forked repository to your local machine.
  3. Set Up Development Environment: Make sure your development environment is set up according to the instructions provided in the README.

🌟 How Can I Contribute?

🐞 Reporting Bugs

  1. Check Existing Issues: Ensure the bug was not already reported by searching on GitHub under Issues.
  2. Create a New Issue: If you're unable to find an open issue addressing the problem, open a new issue using the appropriate issue template.

🆕 Suggesting Enhancements

  1. Check Existing Issues: Ensure the enhancement was not already reported or suggested by searching on GitHub under Issues.
  2. Create a New Issue: Open a new issue using the appropriate issue template to suggest your enhancement.

📜 Pull Requests

  1. Create a Branch: Create a new feature branch related to the issue you are fixing.
  2. Make Changes: Make the necessary changes following coding standards and best practices.
  3. Commit Changes: Commit your changes with a descriptive commit message.
  4. Push to Origin: Push your branch to GitHub.
  5. Open a Pull Request: Go to the GitHub repository and open a new pull request from your feature branch, providing the necessary information.

🎨 Coding Standards

📃 License

By contributing, you agree that your contributions will be licensed under its GPLv3 License.

📜 WordPress Plugin Directory Contributor Listing

If you want to be listed as a contributor on the WordPress Plugin Directory when and if this plugin is released there, please provide your WordPress.org account username when you submit your pull request. This way, we can add you to the contributor's list which will be reflected on the WordPress Plugin Directory.