Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
125 lines (76 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

125 lines (76 loc) · 2.6 KB

🧠 Contributing to ex-tracker

Thanks for your interest in contributing to ex-tracker, a minimalistic Flutter-based expense tracker! 🎉
We welcome all contributors—new and experienced—who want to help make this project better.

📌 Getting Started

1. Fork the repository

Click the "Fork" button on the top right of this repo to create your own copy.

2. Clone your fork

git clone https://github.com/YOUR_USERNAME/ex-tracker.git
cd ex-tracker

3. Set upstream remote (optional but recommended)

git remote add upstream https://github.com/HashSlap-Summer-of-Code/ex-tracker.git

🛠️ Setup Instructions

  1. Make sure Flutter SDK is installed and configured.
  2. Fetch dependencies:
flutter pub get
  1. Run the app:
flutter run

🌟 How to Contribute

Here are some common ways you can help:

  • 🐛 Reporting bugs
  • 💡 Suggesting new features or improvements
  • ✨ Creating UI/UX enhancements
  • 🧪 Writing unit or widget tests
  • 📚 Improving documentation
  • 🚀 Performance optimization

📂 Branch Naming Convention

Please follow this structure when naming your branches:

<type>/<short-description>

Examples:

  • fix/chart-bug
  • feature/dark-mode-toggle
  • docs/update-readme

✅ Pull Request Guidelines

  • PRs should be small, focused, and well-documented.
  • Reference related issue numbers in your pull request description.
  • Make sure to test your code before submitting.
  • Add screenshots or screen recordings if you’ve made UI changes.
  • Follow existing code styles and naming conventions.

📋 Code Style

  • Use proper naming for widgets and variables.
  • Use Flutter’s dart format tool:
dart format .
  • Prefer const constructors where applicable.
  • Try to keep widgets stateless where possible.

💬 Need Help?

We’d love to help you get started!

🧡 Join the Community

This project is part of HashSlap Summer of Code (HSSoC). Everyone is welcome to contribute—learn, build, and grow with us!

📜 Code of Conduct

Please read our Code of Conduct to understand the behavior expected from all contributors.

Thank you for contributing to ex-tracker! 🙌