Skip to content

Latest commit

 

History

History
104 lines (70 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

104 lines (70 loc) · 2.99 KB

Contributing to Personal Finance Tracker

Thank you for your interest in contributing to Personal Finance Tracker! Your help is highly appreciated to make this project better for everyone.

Table of Contents

How to Contribute

We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code changes!

  1. Fork the repository.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes.
  5. Commit your changes with a clear and descriptive message.
  6. Push your changes to your fork.
  7. Submit a pull request (PR) to the main branch.

Code of Conduct

Please read our Code of Conduct to keep this community welcoming and respectful.

Reporting Bugs

  • Ensure the bug was not already reported by searching existing issues.
  • Create a new issue with the following information:
    • Description: A clear and concise description of the bug.
    • Steps to Reproduce: How to reproduce the issue.
    • Expected Behavior: What you expected to happen.
    • Screenshots: If applicable, add screenshots to help explain.

Suggesting Features

  • Search existing issues for similar feature requests.
  • Open a new issue and provide:
    • Feature Description
    • Use Case / Motivation
    • Possible Alternatives

Development Setup

This project uses HTML, CSS, and JavaScript.

  1. Clone the repository: 
    git clone https://github.com/neeraj542/Personal-Finance-Tracker.git
  2. Navigate to the project directory: 
    cd Personal-Finance-Tracker
  3. Open index.html in your browser to view the app locally.

For advanced tasks, follow any setup instructions in the README.md.

Pull Request Process

  • Ensure your PR is up to date with the latest code from main.
  • Clearly describe what your PR does and reference related issues if applicable.
  • Keep your changes focused and atomic; avoid unrelated changes.
  • Your PR will be reviewed. Please be open to feedback and make requested changes.
  • Only merge after approval from a maintainer.

Coding Guidelines

  • Follow existing code style and formatting.
  • Write clear, concise commit messages.
  • Comment your code where necessary.
  • If you add or update significant features, please update the documentation.

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for helping make Personal Finance Tracker better!