Skip to content

Contributing.md

Latest commit

 

History

History
106 lines (65 loc) · 3.21 KB

Contributing.md

File metadata and controls

106 lines (65 loc) · 3.21 KB

🤝 Contributing to Splitwiser

Welcome to the Splitwiser repository! 🎉
We’re thrilled that you’d like to contribute and help improve this smart expense splitting app. Whether you're fixing a bug, adding a new feature, improving documentation, or providing feedback — your help is appreciated.

📦 What is Splitwiser?

Splitwiser is a modern, cross-platform app built with Expo and FastAPI for managing and splitting group expenses — ideal for roommates, friends, or travel groups.

Check out the full project overview in the README.

🧭 How to Contribute

1. Fork the Repository

Click the Fork button on the top-right of the main repository to create a copy under your GitHub account.

2. Clone Your Fork

git clone https://github.com/<your-username>/splitwiser.git
cd splitwiser

3. Create a Feature Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Follow the project’s coding conventions.
  • Keep commits atomic and clear.
  • Write meaningful commit messages.

5. Test Before You Push

  • Ensure that both frontend and backend run without errors.
  • Test your changes on supported platforms (Web/Android/iOS).

6. Push and Open a Pull Request

git push origin feature/your-feature-name

Then open a PR to the main branch of Devasy23/splitwiser.

🛠️ Project Setup

Refer to the Getting Started section in the README.md for full development setup instructions for both the frontend and backend.

✅ Guidelines

  • Follow the Roadmap: See the Project Roadmap before suggesting features.
  • Document Your Code: Use comments and JSDoc/Python docstrings where applicable.
  • Write Clean Code: Maintain readability and consistency across the codebase.
  • Follow File Structure: Don't alter the directory structure unless necessary.

📂 Where to Contribute

Here are some great ways to get started:

  • 🐛 Fix Bugs: Check open issues.
  • ✨ Add Features: See the Roadmap.
  • 🧪 Improve Tests: Add or improve unit/integration tests.
  • 🧹 Refactor Code: Simplify logic and improve performance.
  • 📝 Improve Docs: Help us keep documentation up to date.

🧪 Testing & Linting

Be sure to test your work before submitting:

  • Frontend: Run the Expo app using npm start
  • Backend: Run FastAPI with uvicorn main:app --reload
  • Linting: Use linters/formatters (eslint, black, etc.)

📜 License

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

🙌 Need Help?

If you’re stuck or have any questions:

  • Check open and closed issues
  • Start a new discussion

Thanks for helping make Splitwiser better! 💡💰