Skip to main content

Contributing

Thank you for your interest in contributing to tududi!

Quick Start​

  1. Fork & Clone

    git clone https://github.com/YOUR_USERNAME/tududi.git
    cd tududi

  2. Set Up Environment

    npm install
    cp backend/.env.example backend/.env
    # Edit backend/.env to set NODE_ENV=development and credentials
    npm run db:init

  3. Start Development

    npm run backend:dev    # Terminal 1
    npm run frontend:dev   # Terminal 2

    Log in with the credentials from backend/.env (default test@tududi.com / password123).

  4. Create Branch & Make Changes

    git checkout -b feature/your-feature-name
    # Make your changes
    git commit -m "Clear description of changes"
    git push origin feature/your-feature-name

  5. Open Pull Request

Ways to Contribute​

  • 🐛 Report bugs
  • ✨ Request features
  • 💻 Submit code fixes or new features
  • 📝 Improve documentation
  • 🌍 Add translations (24 languages supported)

Code Guidelines​

Commit Messages​

# Good
git commit -m "Add recurring task support for monthly patterns"
git commit -m "Fix timezone issue in due date calculations"

# Bad
git commit -m "fix stuff"
git commit -m "updates"

Testing​

npm run backend:test
npm run frontend:test
npm run backend:lint
npm run frontend:lint

Translations​

Add or improve translations in public/locales/[language]/ here

Security Issues​

Do not open public issues for security vulnerabilities.

Email: info@tududi.com

Get Help​

Resources​