Skip to content

Contributing

Prashant Maurya edited this page Jul 19, 2026 · 1 revision

Contributing

Thanks for your interest in improving Nestify! Here's how to contribute.

  1. Fork & Clone

bashgit clone https://github.com//Nestify-PG-Management-System.git cd Nestify-PG-Management-System

  1. Create a Branch

Use a descriptive branch name:

bashgit checkout -b feature/payment-gateway-integration

  1. Make Your Changes

Follow the existing package structure (config, controller, entity, repository, service, util). Keep controllers thin — business logic belongs in the service layer. For frontend changes, keep components in frontend/src/pages and shared logic in frontend/src/api.js / AuthContext.jsx.

  1. Test Before Submitting

Backend: run mvn test (add tests for new services/controllers where possible). Frontend: run npm run build to make sure it compiles cleanly.

  1. Commit & Push

Use clear, conventional commit messages:

bashgit commit -m "feat: add Razorpay integration for rent payments" git push origin feature/payment-gateway-integration

  1. Open a Pull Request

Describe what changed and why. Link any related issue. Add screenshots for UI changes.

Code Style

Java: standard Spring Boot conventions, meaningful entity/DTO names. React: functional components + hooks, Tailwind utility classes for styling.

Reporting Bugs / Requesting Features

Open an issue with:

Steps to reproduce (for bugs) Expected vs actual behavior Screenshots/logs if relevant

Clone this wiki locally