Contributing#

Welcome to contributions to SETAP-B! Here’s how you can help:

Getting Started#

  1. Fork the repository on GitHub

  2. Clone your fork locally

  3. Create a new branch for your feature: git checkout -b feature/your-feature-name

  4. Make your changes

  5. Commit with clear commit messages

  6. Push to your fork

  7. Create a Pull Request

Development Guidelines#

Code Style#

Python (Backend)

  • Follow PEP 8 style guide

  • Use meaningful variable names

  • Write docstrings for functions and classes

  • Use type hints

Dart (Frontend)

  • Follow Dart style guide

  • Use meaningful variable names

  • Write comments for complex logic

  • Format code with dart format

Testing#

  • Write tests for new features

  • Ensure all tests pass before submitting a PR

  • Maintain or improve code coverage

Documentation#

  • Update documentation for new features

  • Write clear commit messages

  • Include docstrings in code

Reporting Issues#

If you find a bug or have a suggestion:

  1. Check if the issue already exists

  2. Provide a clear description

  3. Include steps to reproduce (for bugs)

  4. Include relevant system information

License#

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