Contributing

Contributing Guide

Thank you for your interest in contributing to the Accessibility Widget! We welcome contributions from the community.

🤝 How to Contribute

There are many ways to contribute:

1. Report Bugs - Help us find and fix issues
2. Suggest Features - Share your ideas for improvements
3. Submit Code - Fix bugs or add features
4. Improve Documentation - Help make docs better
5. Share Feedback - Tell us what you think

🐛 Reporting Bugs

Before Reporting

1. Check if the bug has already been reported
2. Test on the latest version
3. Try to reproduce the issue
4. Check browser console for errors

Bug Report Template

When reporting a bug, please include:

**Description:**
Clear description of the bug

**Steps to Reproduce:**
1. Step one
2. Step two
3. Step three

**Expected Behavior:**
What should happen

**Actual Behavior:**
What actually happens

**Browser and Version:**
Chrome 120, Firefox 121, etc.

**Operating System:**
Windows 10, macOS 14, etc.

**Screenshots:**
If applicable

**Console Errors:**
Any JavaScript errors

💡 Suggesting Features

Feature Request Template

**Feature Description:**
Clear description of the feature

**Use Case:**
Why is this feature needed?

**Proposed Solution:**
How should it work?

**Alternatives:**
Other solutions considered

**Additional Context:**
Any other information

💻 Code Contributions

Getting Started

1. Fork the Repository

   git clone https://github.com/airforcerp/Website-Accessibility-Widget.git
   cd Website-Accessibility-Widget

2. Create a Branch

   git checkout -b feature/your-feature-name
   # or
   git checkout -b fix/your-bug-fix

3. Make Changes

   • Write clean, readable code
   • Follow existing code style
   • Add comments where needed
   • Test your changes

4. Test Your Changes

   • Test in multiple browsers
   • Test on mobile devices
   • Ensure no console errors
   • Test all affected features

5. Commit Your Changes

   git add .
   git commit -m "Description of your changes"

6. Push and Create Pull Request

   git push origin feature/your-feature-name

Code Style

• JavaScript: Use ES6+ features, follow existing patterns
• CSS: Use consistent naming, comment complex styles
• Comments: Add comments for complex logic
• Indentation: Use 4 spaces (not tabs)

Pull Request Guidelines

1. Clear Description: Describe what your PR does
2. Reference Issues: Link to related issues
3. Screenshots: Include screenshots if UI changes
4. Testing: Describe how you tested
5. Breaking Changes: Note any breaking changes

Pull Request Template

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code refactoring

## Testing
How was this tested?

## Checklist
- [ ] Code follows style guidelines
- [ ] Self-review completed
- [ ] Comments added for complex code
- [ ] Documentation updated
- [ ] No new warnings
- [ ] Tests pass
- [ ] Tested in multiple browsers

📝 Documentation Contributions

Improving Documentation

• Fix typos and grammar
• Add missing information
• Improve clarity
• Add examples
• Update outdated information

Documentation Style

• Use clear, concise language
• Include code examples
• Add screenshots when helpful
• Keep formatting consistent

🧪 Testing

Before Submitting

• Test in Chrome
• Test in Firefox
• Test in Safari
• Test in Edge
• Test on mobile (iOS)
• Test on mobile (Android)
• No console errors
• All features work
• No performance issues

Testing Checklist

// Test basic functionality
AccessibilityPlugin.toggle();
AccessibilityPlugin.setFontSize(150);
AccessibilityPlugin.setContrast('high');
AccessibilityPlugin.reset();

// Test TTS (if supported)
AccessibilityPlugin.speak('Test');
AccessibilityPlugin.stopSpeaking();

// Test settings persistence
const settings = AccessibilityPlugin.getSettings();
// Reload page and verify settings persist

🎯 Development Priorities

High Priority

• Bug fixes
• Accessibility improvements
• Performance optimizations
• Browser compatibility fixes

Medium Priority

• New features
• UI/UX improvements
• Documentation updates
• Code refactoring

Low Priority

• Nice-to-have features
• Minor UI tweaks
• Additional examples

📋 Contribution Checklist

Before submitting:

• Code follows style guidelines
• All tests pass
• Documentation updated
• No console errors
• Tested in multiple browsers
• Tested on mobile devices
• No breaking changes (or documented)
• Commit messages are clear

🔍 Code Review Process

1. Initial Review: Maintainers review PR
2. Feedback: Comments and suggestions provided
3. Changes: Contributor makes requested changes
4. Final Review: Final review and approval
5. Merge: PR is merged into main branch

📜 License

By contributing, you agree that your contributions will be licensed under the same license as the project (free to use and modify).

🙏 Recognition

Contributors will be:

• Listed in CONTRIBUTORS.md (if created)
• Credited in release notes
• Thanked in the project

🆘 Need Help?

• Check Development Setup guide
• Review Architecture documentation
• Open an issue for questions
• Email: support@airforcerp.com

Subject (Contributing Accessibility) otherwise ignored

📚 Related Pages

• Development Setup
• Architecture
• API Documentation

---

Thank you for contributing! 🎉

Last Updated: November 2025