How to Contribute

Join the WakaPAC community and help make it better. Learn how to contribute code, documentation, and improvements to the project.

Getting Started

Set up your development environment:

# Fork the repository on GitHub
# Clone your fork
git clone https://github.com/quellabs/wakapac.git
cd wakapac

Development Workflow

Follow our development process:

# Create a feature branch
git checkout -b feature/amazing-feature

# Make your changes
# Add tests for new functionality
# Update documentation if needed

# Commit your changes
git add .
git commit -m "Add amazing new feature"

# Push to your fork
git push origin feature/amazing-feature

# Create a Pull Request on GitHub

Code Style Guidelines

WakaPAC follows PSR-12 Extended Coding Style Guide with these key requirements:

  • Use tabs for indentation, not spaces
  • Opening braces for classes and methods go on the same line
  • Always use strict types declaration
  • Follow PascalCase for class names, camelCase for methods and properties
  • Use UPPER_SNAKE_CASE for constants
  • Include complete JSDoc blocks for all classes and methods

Communication Channels

  • GitHub Issues: Bug reports and feature requests
  • GitHub Discussions: Questions and community ideas
  • Stack Overflow: Tag questions with 'WakaPAC'

Ways to Contribute

  • Fix bugs and add new features
  • Improve documentation and examples
  • Write tutorials and guides
  • Answer questions in the community
  • Review pull requests from other contributors
  • Test new releases and report issues

Getting Help

If you need assistance while contributing:

  • Check the README.md for basic usage and setup
  • Browse existing GitHub Issues for similar problems
  • Start a GitHub Discussion for questions
  • Review the codebase for examples and patterns
  • Ask for help in your pull request if you get stuck

Thank you for considering contributing to WakaPAC! Your contributions help make the project better for everyone.