Skip to content

Latest commit

 

History

History
89 lines (69 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

89 lines (69 loc) · 2.16 KB

Contributing to DataVerse

Thank you for your interest in contributing to DataVerse! We welcome all contributions from the community to help improve this machine learning powerhouse.

Getting Started

Prerequisites

  • Python 3.8+
  • pip
  • Git

Installation

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/GZ30eee/mlp.git
  3. Set up a virtual environment: 
    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  4. Install dependencies: 
    pip install -r requirements.txt

Contribution Workflow

  1. Find an Issue:

    • Check the Issues tab for open tasks
    • Good first issues are labeled good first issue

  2. Create a Branch:

    git checkout -b feature/your-feature-name

  3. Make Your Changes:

    • Follow our coding standards (see below)
    • Write tests for new functionality
    • Update documentation when needed

  4. Submit a Pull Request:

    • Push your changes: git push origin master
    • Open a PR against the master branch
    • Include a clear description of your changes

Coding Standards

Python Code

  • Follow PEP 8 style guidelines
  • Use type hints where appropriate
  • Keep functions small and focused
  • Add docstrings for all public methods

Frontend (Streamlit)

  • Use consistent naming for UI elements
  • Keep the user interface intuitive
  • Add clear section headers

Testing

  • Write unit tests for new functionality
  • Maintain 80%+ test coverage
  • Run tests before submitting: 
    pytest

Reporting Issues

When reporting bugs:

  1. Check if the issue already exists
  2. Include steps to reproduce
  3. Add error messages and screenshots if applicable
  4. Specify your environment (OS, Python version, etc.)

Feature Requests

We welcome feature ideas! Please:

  • Explain the problem it would solve
  • Suggest potential implementations
  • Note any similar features in other projects

Code of Conduct

All contributors are expected to follow our Code of Conduct. Be respectful and inclusive in all interactions.

Happy coding! 🚀