Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 3 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 3 KB
Raw

Contributing to the Obesity Classification Project

Thank you for your interest in contributing to the Obesity Classification Project. This guide outlines the process for making contributions, reporting issues, and suggesting improvements. Your input helps us improve the project and advance its mission of leveraging machine learning to predict and manage obesity levels.

How You Can Contribute

Fixing Typos and Improving Documentation

Small corrections, such as fixing typos or improving grammar in the documentation, can be made directly using the GitHub web interface.

  • YES: Edit the .md files below main/ or markdown cells in .ipynb files in the notebooks/ folder.
  • NO: Edit auto-generated documentation files or outputs in data/.

Reporting Issues

If you encounter a bug, have a question, or wish to propose a new feature:

  1. Search the Issues page to see if your concern has already been addressed.
  2. If not, open a new issue, providing:
    • A clear and descriptive title.
    • A detailed explanation of the problem or suggestion.
    • (For bugs) Steps to reproduce and, if possible, a minimal code example.

Making Code Contributions

Prerequisites

Before making a significant pull request (PR):

  1. File an issue describing the change or feature. Wait for feedback from the team to ensure alignment.
  2. Ensure your development environment matches the project setup. Refer to README.md for dependencies and setup instructions.

Pull Request Process

  1. Branching: Create a separate Git branch for each PR:
    • Use a descriptive name such as fix-bug-xyz or add-svm-optimization.
  2. Code Style:
    • Ensure Python code in Jupyter notebooks follows PEP8 (PEP8 Style Guide).
    • Use clear and consistent markdown formatting in notebook cells.
  3. Testing: Ensure all existing tests pass and, if necessary, write new tests for added functionality. If applicable, include test cells in the relevant Jupyter notebook.
  4. Commit Messages: Write clear and concise commit messages that explain the purpose of your changes.
  5. Open a PR:
    • Describe your changes and reference the related issue(s).
    • Highlight any significant design decisions or trade-offs made.

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating, you agree to uphold its principles and contribute in a respectful and inclusive manner.

Attribution

These contribution guidelines were inspired by the dplyr contributing guidelines and the PEP8 style guide.

Reference Statement

This md file is adapted by work from Tiffany A. Timbers in breast-cancer-predictor repository CONTRIBUTING.md link here