Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
147 lines (97 loc) · 4.66 KB

CONTRIBUTING.md

File metadata and controls

147 lines (97 loc) · 4.66 KB

💸 Contributing to ExpenseFlow – Smart Expense Tracker

Thank you for your interest in contributing to ExpenseFlow!
We’re thrilled that you want to help make this modern, responsive expense tracking app even better.
Before getting started, please take a moment to read this guide carefully.

🔗 Read First: Open Issues & Discussion to check active tasks and community discussions before contributing.

🧭 Code of Conduct

By participating in this project, you agree to uphold our Code of Conduct.
Please report any unacceptable behavior to the maintainers for review.

🚀 How Can I Contribute?

🐞 Reporting Bugs

Before creating a bug report, check existing issues to avoid duplicates.
When you report a bug, include as much information as possible:

  • 📝 Use a clear and descriptive title
  • 🧭 Describe exact steps to reproduce the issue
  • 🖼️ Include screenshots or console errors, if available
  • 🔍 Describe the expected behavior vs. the actual behavior
  • 🌐 Mention your browser/device environment

💡 Suggesting Enhancements

Enhancement suggestions help improve user experience and usability.
When creating an enhancement issue, please include:

  • 🏷️ A descriptive title for your idea
  • 📋 Step-by-step description of the enhancement
  • 🔄 Current vs. expected behavior
  • 💭 Why this improvement would be useful for users
  • 🧩 Add mockups, wireframes, or examples if possible

🧩 Pull Requests

Follow these steps when submitting your pull request:

  1. Follow all instructions in the PR template
  2. Review and follow our Styleguides
  3. Verify that all code works and passes validation before submission

After submission, the reviewer(s) may request design adjustments, code changes, or tests before final acceptance.

✅ Steps to Contribute

# 1️⃣ Fork the repository
git fork https://github.com/Renu-code123/ExpenseFlow-expensetracker.git

# 2️⃣ Clone your fork
git clone https://github.com/your-username/ExpenseFlow-expensetracker.git

# 3️⃣ Create a feature branch
git checkout -b feature/your-feature-name

# 4️⃣ Make your changes and commit
git commit -m "Add: new feature or fix"

# 5️⃣ Push to your branch
git push origin feature/your-feature-name

#6️⃣ Open a Pull Request on GitHub 🎉

## 🎨 Styleguides

### 🧾 Git Commit Messages

- ✍️ Use **present tense** (“Add feature” not “Added feature”)  
- 💬 Use **imperative mood** (“Fix bug” not “Fixes bug”)  
- 📏 Keep the first line under **72 characters**  
- 🔗 Reference related issues when possible (`#issue-number`)

---

### 💻 JavaScript Guidelines

- 🧠 Follow **JavaScript Standard Style** → [standardjs.com](https://standardjs.com/)  
- 🐫 Use `camelCase` for variables and functions  
- 🧱 Use `PascalCase` for constructors and classes  
- 🔤 Write **clear, descriptive variable names**  
- 💭 Add **comments** for complex or critical logic  

---

### 🎨 HTML/CSS Guidelines

- 🌐 Use **semantic HTML5** tags properly  
- 🧩 Follow **BEM (Block Element Modifier)** naming convention for CSS classes  
- ⬜ Maintain **2-space indentation** for consistency  
- 💬 Comment **complex or responsive** CSS rules  
- 🌙 Keep design **consistent** with dark theme guidelines  

---

## ⚙️ Development Setup

To set up **ExpenseFlow** locally, follow these steps:

```bash
# 1️⃣ Clone the repository
git clone https://github.com/Renu-code123/ExpenseFlow-expensetracker.git

# 2️⃣ Navigate into the project directory
cd ExpenseFlow-expensetracker

# 3️⃣ Open the HTML file in a browser
open expenseTracker.html

# OR run it using live server
npx live-server

## 🏷️ Issue and Pull Request Labels

We use the following labels to organize and identify contributions:

| Label | Description |
|-------|--------------|
| 🐞 **bug** | Reports broken functionality |
| 🚀 **enhancement** | Suggests new features or improvements |
| 📚 **documentation** | Related to project documentation |
| 🌱 **good first issue** | Ideal for new contributors |
| 🤝 **help wanted** | Extra help or review needed |

---

## 💜 Additional Notes

- ✅ Please ensure your code is **clean, readable, and tested**  
- 🙌 Be **respectful and supportive** of all contributors  
- 💡 Your contribution — big or small — makes **ExpenseFlow** better!  

---

## 🌟 Let’s Build Together

If you love **ExpenseFlow**, don’t forget to ⭐ **star the repository** and spread the word!  
Together, let’s build **smarter tools for financial awareness.** 💰💡