Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (76 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

99 lines (76 loc) · 2.73 KB

Contributing to SimpleBudget

Thank you for your interest in SimpleBudget! This project is designed to be simple, accessible, and helpful for everyone — especially non-technical users.

Philosophy

SimpleBudget is built on these principles:

  • Simplicity first: Keep it easy to understand
  • Privacy always: No data leaves the user's device
  • Accessibility matters: Large buttons, clear text, works for everyone
  • No barriers: No signup, no account, no internet required
  • Open forever: Free for everyone, everywhere

Getting Started

How to Test

  1. Download the repository
  2. Open index.html in any web browser
  3. Or run a local server: 
    python3 -m http.server 8080
# Then open http://localhost:8080

Making Changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Edit index.html (it contains HTML, CSS, and JavaScript all in one file)
  4. Test in multiple browsers (Chrome, Firefox, Safari, Edge)
  5. Test on mobile if possible
  6. Commit with clear messages
  7. Push and open a Pull Request

Code Style

  • Keep everything in index.html
  • Use clear, descriptive variable names
  • Comment complex sections
  • Maintain accessibility:
    • Large fonts and buttons
    • High contrast colors
    • Clear labels for inputs
    • Keyboard navigation support

Accessibility Guidelines

When making changes, ensure:

  • ✅ All text is readable (at least 14px)
  • ✅ Buttons are large enough to tap (min 44px height)
  • ✅ Color contrast meets WCAG AA standards
  • ✅ Forms have clear labels
  • ✅ Error messages are helpful and specific
  • ✅ Works with screen readers (use semantic HTML)

Feature Ideas We'd Love

  • 📝 Edit existing transactions
  • 📊 Monthly/weekly reports
  • 🖨️ Print-friendly reports
  • 🌍 Multiple language support
  • 📈 Simple charts and graphs
  • 💰 Savings goals tracking
  • 📅 Calendar view of spending
  • 🔄 Import from exported data
  • 🎨 Theme options (light/dark)

Testing Checklist

Before submitting a PR:

  • Works in Chrome
  • Works in Firefox
  • Works in Safari
  • Works on mobile (responsive design)
  • No JavaScript errors in console
  • Data saves correctly to localStorage
  • Export function works
  • Delete confirmation works
  • Help text is clear

Reporting Issues

When reporting bugs, please include:

  • Browser name and version
  • Device (desktop, phone, tablet)
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Screenshots if possible

Questions?

Feel free to open an issue or start a discussion. We're especially interested in feedback from non-technical users!

Remember: The goal is simplicity. If a change makes it more complex, think carefully.

Happy contributing! 💚