Repository navigation
Contributing
This page outlines how to contribute to the Aegis theme. Contributions are welcome from the community, whether they are bug fixes, new features, documentation improvements, or translations.
- Fork the Aegis repository on GitHub.
- Clone your fork locally.
- Set up the development-setup.
- Create a branch for your contribution.
- Make your changes.
- Submit a pull request.
Aegis uses a branching model with the following branches:
| Branch | Purpose | Merges Into |
|---|---|---|
main |
Production-ready releases | — |
develop |
Integration branch for next release | main |
feature/* |
New features | develop |
fix/* |
Bug fixes | develop |
hotfix/* |
Critical production fixes |
main and develop
|
docs/* |
Documentation updates | develop |
Use descriptive branch names with the appropriate prefix:
feature/add-accordion-block
fix/slider-navigation-a11y
hotfix/critical-php-error
docs/update-pattern-reference
# Start from the develop branch
git checkout develop
git pull origin develop
# Create your feature branch
git checkout -b feature/your-feature-nameAll contributions must follow the project coding standards:
- PHP — WordPress PHP Coding Standards (enforced via PHPCS).
- JavaScript — WordPress JavaScript Coding Standards (enforced via ESLint).
- CSS — WordPress CSS Coding Standards (enforced via stylelint).
- No abbreviations or contractions in user-facing text.
See code-quality for detailed linting information.
Write clear, descriptive commit messages:
feat: add countdown block with configurable target date
- Register countdown block with block.json metadata
- Add editor component with date picker control
- Add frontend JavaScript for timer animation
- Add responsive styles for mobile viewports
- Add unit tests for countdown logic
| Prefix | Usage |
|---|---|
feat: |
New feature |
fix: |
Bug fix |
docs: |
Documentation only |
style: |
Code style (formatting, no logic change) |
refactor: |
Code restructuring (no feature/fix) |
test: |
Adding or updating tests |
chore: |
Build process, dependencies, tooling |
perf: |
Performance improvement |
a11y: |
Accessibility improvement |
Before submitting a PR:
# Run linting
npm run lint
# Run tests
composer run test
npm run test
# Run accessibility tests
npm run test:a11y
# Build production assets
npm run buildAll commands must pass without errors.
-
Push your branch to your fork:
git push -u origin feature/your-feature-name
-
Open a pull request against the
developbranch on the main repository. -
Fill in the PR template with:
- Summary of changes.
- Related issue number (if applicable).
- Testing steps.
- Screenshots (for visual changes).
Keep PR titles concise and descriptive (under 70 characters):
feat: add countdown block with date picker
fix: resolve slider navigation focus issue
docs: update template reference table
## Summary
Brief description of what this PR does.
## Related Issues
Closes #123
## Changes
- Added countdown block registration
- Added editor component with date picker
- Added frontend timer animation
- Added unit tests
## Testing
1. Start the local environment
2. Insert a Countdown block
3. Set a target date in the future
4. View the frontend and verify the timer counts down
## Screenshots
(Include screenshots for visual changes)
## Checklist
- [ ] Code follows project coding standards
- [ ] Tests pass locally
- [ ] No accessibility regressions (pa11y passes)
- [ ] Documentation updated (if applicable)
- [ ] Build completes without errorsAll PRs go through code review:
- Automated checks — CI runs linting, tests, and accessibility checks.
- Maintainer review — A project maintainer reviews the code.
- Feedback — Address any requested changes by pushing additional commits.
- Approval — Once approved, the PR is merged.
| Criterion | Description |
|---|---|
| Code quality | Follows coding standards, well-structured |
| Functionality | Works as intended, no regressions |
| Performance | Does not degrade page load performance |
| Accessibility | Meets WCAG 2.1 AA, no a11y regressions |
| Testing | Appropriate tests included |
| Documentation | Code is documented, user docs updated if needed |
- Check existing issues for duplicates.
- Create an issue describing the bug (if one does not exist).
- Reference the issue in your PR.
- Include a test that verifies the fix.
- Open a feature request issue first to discuss the proposal.
- Wait for maintainer feedback before investing significant effort.
- Follow the established architecture patterns.
- Include tests and documentation.
Documentation PRs use the docs/* branch prefix and typically update:
- Wiki pages (in the
.wiki/directory). - Code comments (PHPDoc, JSDoc).
- README files.
- Inline documentation.
Translations are managed through WordPress.org or direct contributions:
- Generate a fresh
.potfile:npm run translate. - Create a
.pofile for your locale. - Submit the translation via PR or the WordPress translation platform.
When reporting bugs:
- Search existing issues first.
- Include:
- WordPress version.
- PHP version.
- Aegis version.
- Steps to reproduce.
- Expected behavior.
- Actual behavior.
- Screenshots or screen recordings (if visual).
- Be respectful and constructive.
- Follow the WordPress Community Code of Conduct.
- Help others when you can.
- Ask questions if something is unclear.
- development-setup — Set up your local environment.
- code-quality — Understand coding standards.
- testing — Run the test suite.
- architecture — Understand the codebase structure.
Aegis version 1.0.0 | GitHub Repository | Report an Issue | Atmostfear Entertainment
License: GPL-2.0-or-later