Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (51 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 1.74 KB

Contributing to Refilea

Thank you for your interest in contributing to Refilea! 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

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Make your changes
  4. Test your changes thoroughly
  5. Submit a pull request

Development Setup

  1. Clone the repository:
git clone https://github.com/yourusername/Refilea.git
cd Fuxee
  1. Install dependencies:
pip install -r requirements.txt
  1. Run the application:
python flet_gui.py

Pull Request Process

  1. Update the README.md with details of changes if needed
  2. Update the version numbers in relevant files following Semantic Versioning
  3. Ensure your code follows the existing style
  4. Include comments and documentation where necessary
  5. Test your changes thoroughly

Reporting Bugs

When reporting bugs, please include:

  • A clear description of the issue
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable
  • Your operating system and Python version

Feature Requests

Feature requests are welcome! Please provide:

  • A clear description of the feature
  • Why you think it would be useful
  • Any potential implementation details

Code Style

  • Follow PEP 8 guidelines
  • Use meaningful variable and function names
  • Include docstrings for functions and classes
  • Keep functions focused and single-purpose
  • Comment complex logic

License

By contributing to Refilea, you agree that your contributions will be licensed under the same license as the project.