48 lines (37 loc) · 1.35 KB

Contributing to SCF

Guide for contributing to Secure Custom Fields development.

Ways to Contribute

Code Contributions
- Bug fixes
- New features
- Performance improvements
- Security enhancements
Documentation
- Writing tutorials
- Improving reference docs
- Fixing errors
- Adding examples
Testing
- Unit testing
- Integration testing
- Bug reporting
- Feature validation

Development Setup

Fork the repository
Set up local environment
- The local environment runs with WP env, for setup, see: https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/ along with prerequisites.
Install dependencies
- run composer install
- build the plugin files (JS/CSS) via npm run build
Run test suite
- composer run test

Release Management

There are some prerequisites for a release:

You will need npm, composer and GH cli (https://github.com/cli/cli?tab=readme-ov-file#installation) installed.
Use the scripts provided composer prepare-release (which includes update-translations) or composer update-translations to prepare the release.
Follow the instructions in the script to create a release.

Contribution Guidelines

Follow WordPress coding standards
Write unit tests for new features
Document all changes
Keep pull requests focused