Skip to content

Contributing Guide

Collins Dada edited this page Apr 22, 2025 · 2 revisions

Contributing Guide

Welcome! Here’s how to get involved and contribute effectively to the Expense Tracker project.


Contribution Structure

We encourage contributions in the following areas:

Area Contribution Ideas
Backend New filters, improved data storage options, optimization
Frontend UI polish, better chart UX, faster responsiveness
Data Science Budget prediction, smart categorization algorithms
DevOps Deployment setup, Docker support, CI/CD integrations

🛠️ Getting Started

  1. Fork the Repo

    git clone https://github.com/your-username/Expense-Tracker.git
    cd Expense-Tracker
    
  2. Create a Branch

    git checkout -b your-feature-name
    
  3. Install Dependencies

    pip install -r requirements.txt
    
  4. Develop Locally

    • Make your changes

    • Ensure everything runs properly:

      streamlit run app.py
      
  5. Commit and Push

    git add .
    git commit -m "Add your message here"
    git push origin your-feature-name
    
  6. Submit a Pull Request

    • Go to your forked repo

    • Open a PR against the main branch


⚙️ Code Standards

  • Use clear, descriptive commit messages

  • Write modular, documented functions

  • Avoid hardcoding — opt for config or constants

  • Follow PEP8 for Python formatting


🔍 Review Process

Your PR will be reviewed within 48–72 hours by maintainers. Feedback might be provided for improvements before merging.


🙌 First Time Contributors

We love helping newcomers, students or experienced Programmers! Look out for issues labeled good first issue or help wanted on our GitHub issues tab.

Clone this wiki locally