Skip to content

Latest commit

 

History

History
60 lines (40 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 2.06 KB
Raw

Contributing to Mini Property Management System

Welcome! We're excited that you're interested in contributing to our project. Before you get started, please take a moment to review the following guidelines.

How to Contribute

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contributions:
git checkout -b feature/your-feature-name
  1. Make your changes, following the coding conventions and guidelines outlined below.
  2. Commit your changes:
git commit -am 'Add some feature'
  1. Push to the branch:
git push origin feature/your-feature-name
  1. Create a new Pull Request against the main branch of the original repository.

Coding Conventions

Java Spring Boot Backend

  • Follow the Java Code Conventions for formatting and naming conventions.
  • Write clean, readable, and maintainable code.
  • Use meaningful variable and method names.
  • Write Javadoc comments for public APIs and classes.

React Frontend

  • Follow the Airbnb JavaScript Style Guide for JavaScript and React conventions.
  • Write JSX and JavaScript using ES6+ syntax.
  • Use functional components whenever possible.
  • Organize your code logically into reusable components.
  • Use meaningful names for components and variables.

Testing

  • Write unit tests for your code using JUnit for Java backend and Jest/React Testing Library for React frontend.
  • Ensure that all existing tests pass before submitting your changes.
  • Write additional tests as necessary to cover new functionality or bug fixes.

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub with a detailed description of the problem or feature request.

Code of Conduct

Please note that this project is governed by our Code of Conduct. By participating in this project, you agree to abide by its terms.

Thank you for contributing to [Project Name]!