Skip to content

Latest commit

 

History

History
140 lines (101 loc) · 3.84 KB

CONTRIBUTING.md

File metadata and controls

140 lines (101 loc) · 3.84 KB

Contributing to ExpenseFlow

Thank you for considering contributing to ExpenseFlow! We welcome contributions from everyone.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed and what you expected to see
  • Include screenshots or animated GIFs if applicable
  • Note your environment (OS, browser, version, etc.)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, include:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested enhancement
  • Explain why this enhancement would be useful
  • List any similar features in other applications if applicable

Pull Requests

  1. Fork the repository and create your branch from main
  2. Make your changes following our style guidelines
  3. Test your changes thoroughly
  4. Update documentation if needed
  5. Ensure your code follows the existing style
  6. Write clear, descriptive commit messages
  7. Submit a pull request

Pull Request Process

  • Fill in the pull request template
  • Link any related issues
  • Request review from maintainers
  • Address any feedback from code reviews
  • Wait for approval before merging

Development Setup

  1. Clone the repository

    git clone https://github.com/Renu-code123/ExpenseFlow.git
cd ExpenseFlow

  2. Install dependencies

    npm install
# or
yarn install

  3. Create a new branch

    git checkout -b feature/your-feature-name

  4. Make your changes and test them

  5. Commit your changes

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

  6. Push to your fork

    git push origin feature/your-feature-name

Style Guidelines

JavaScript/TypeScript

  • Use meaningful variable and function names
  • Add comments for complex logic
  • Follow existing code formatting
  • Use ES6+ features where appropriate
  • Keep functions small and focused

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests after the first line

Example:

Add expense category filter

- Implement dropdown for category selection
- Update expense list based on selected category
- Add tests for filter functionality

Fixes #18

Getting Help

If you need help or have questions:

  • Check the README. md for basic information
  • Search existing issues for similar questions
  • Create a new issue with the "question" label
  • Reach out to the maintainers

🌟 Recognition

All contributors will be acknowledged in our README.md file.
Thank you for helping improve ExpenseFlow!

⭐ If you like this project, don’t forget to star ⭐ the repository — your support means a lot.

Happy Contributing! 🎉