Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 2.09 KB
Raw

Contributing to FirehawkCRM Tributes Enhancement Suite

Thank you for your interest in contributing to the Firehawk Tributes Enhancement Suite! We appreciate your effort and want to make the contribution process as easy as possible.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch (git checkout -b feature/amazing-feature)
  4. Make your changes
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Coding Standards

This project follows WordPress coding standards. Please ensure your code:

  • Follows WordPress PHP Coding Standards
  • Uses proper inline documentation for functions and classes
  • Includes meaningful commit messages
  • Uses NZ English spelling where applicable (e.g., 'colour' instead of 'color')

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the CHANGELOG.md following the existing format
  3. Include a clear description of the changes in your pull request
  4. The pull request will be merged once reviewed and approved

Development Workflow

  1. Check existing issues/discussions before starting new work
  2. Create a new issue for any bugs or feature requests
  3. Reference issues in commit messages and pull requests
  4. Test changes thoroughly before submitting

Reporting Bugs

When reporting bugs, please include:

  1. A clear description of the issue
  2. Steps to reproduce the behaviour
  3. Expected behaviour
  4. WordPress version
  5. PHP version
  6. FirehawkCRM Tributes plugin version
  7. Any relevant error messages or screenshots

Feature Requests

Feature requests are welcome! Please provide:

  1. A clear description of the feature
  2. Why you think it would be useful
  3. Any examples of similar features elsewhere

Questions?

If you have questions about contributing, please:

  1. Check existing issues and documentation
  2. Create a new issue if needed
  3. Be clear and concise in your communication

Thank you for contributing!