Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (40 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

65 lines (40 loc) · 3.91 KB
Raw

Contributing to the D.S.B Project: Development of a Health and Wellness System

Thank you for your interest in contributing to D.S.B! This document provides guidelines for contributing to the project and ensuring that your collaboration is effective and constructive.

About the Project

D.S.B is a web application aimed at improving the health and wellness of individuals with chronic diseases such as hypertension and diabetes, as well as those with varying BMI and unhealthy eating habits. The application offers features like physical activity and diet tracking, personalized plans, medical history, and treatment reminders, among others. The project is developed in Java using Spring Boot and includes database integration for effective information management.

How to Contribute

Reporting Issues

  1. Search for Duplicates: Before opening a new issue, check if a similar one already exists.
  2. Create an Issue: If you do not find a similar issue, open a new one providing a clear title and a detailed description of the problem. Include steps to reproduce the issue, expected results, and current results.

Pull Requests

  1. Fork the Repository: Fork the repository and clone your fork to your local machine.
  2. Create a Branch: Create a new branch for your contribution. Use descriptive names for branches (e.g., feature/add-reminders or bugfix/fix-login-error).
  3. Make Changes: Ensure you follow the style guides and add comments when necessary. If you’re adding new functionality, include unit tests.
  4. Commit Changes: Write clear and descriptive commit messages.
  5. Push to Your Fork: Push your branch to your fork on GitHub.
  6. Create a Pull Request: Open a pull request from your branch to the main branch of the original repository. Describe the changes made and provide additional context if necessary.

Code Review

Pull requests will be reviewed by other contributors. Make sure to respond to reviews and make requested changes for your pull request to be accepted.

Code Style

Follow the project's style guides to maintain clean and consistent code:

  • Java and Spring Boot: Adhere to Java coding conventions and best practices for Spring Boot.
  • Database: Ensure that SQL queries and database configurations are optimized and secure.
  • HTML/CSS/JavaScript: Make sure the code is readable and well-commented.
  • Documentation: Update documentation when adding new features or making significant changes.

Setting Up the Development Environment

To contribute to the project, follow these steps to set up your development environment:

  1. Clone the Repository: Clone the repository to your local machine.
  2. Set Up the Database: Ensure you have an instance of MySQL (or another configured database) and create the necessary tables by executing the provided SQL scripts.
  3. Set Up the Project in Your IDE: Import the project into your preferred IDE (recommended: IntelliJ IDEA) and ensure Spring Boot is configured.
  4. Environment Variables: Configure the necessary environment variables, such as database credentials, in your application.properties file.

Communication

For any questions or discussions, use the following channels:

  • Issues: To report problems or suggest improvements.
  • Pull Requests: To discuss specific changes in the code.
  • Email: You can contact us at email@example.com for more general questions or closer collaboration.

Code of Conduct

This project adheres to a Code of Conduct to foster an open and respectful collaborative environment. Please read and adhere to it while contributing to the project.

Acknowledgments

We appreciate all contributors and users who help improve D.S.B. Your support and collaboration are invaluable!

Thank you for taking the time to contribute to D.S.B. Together, we can create a powerful tool to improve the health and wellness of many individuals.