Spaces:
Sleeping
Sleeping
Contributing to WikiFit
Thank you for your interest in contributing to WikiFit! This document provides guidelines and instructions for contributing to this project.
Code of Conduct
By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.
How to Contribute
Reporting Bugs
If you find a bug, please create an issue with the following information:
- A clear, descriptive title
- Steps to reproduce the bug
- Expected behavior
- Actual behavior
- Screenshots if applicable
- Any additional context
Suggesting Features
We welcome feature suggestions! Please create an issue with:
- A clear, descriptive title
- Detailed description of the proposed feature
- Explanation of why this feature would be valuable
- Any implementation ideas you have
Pull Requests
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Pull Request Guidelines
- Update the README.md with details of changes if applicable
- Update the documentation if necessary
- The PR should work properly on all supported platforms
- Follow the Python PEP 8 style guide
- Include appropriate docstrings for new functions
- Ensure any new Streamlit components are responsive
Development Setup
- Fork and clone the repository
- Install dependencies:
pip install -r requirements.txt - Run the app:
streamlit run app.py - Make your changes in a feature branch
License
By contributing to WikiFit, you agree that your contributions will be licensed under the same license as the project.
Thank you for helping make WikiFit better!