Skip to content

contributing.md

Latest commit

 

History

History
66 lines (50 loc) · 1.99 KB

contributing.md

File metadata and controls

66 lines (50 loc) · 1.99 KB

Contributing to SmartSubAI

Thank you for your interest in contributing to SmartSubAI! We welcome contributions from everyone who is interested in improving the project.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone https://github.com/OCEANOFANYTHING/SmartSubAI.git
cd SmartSubAI
  3. Create a virtual environment and install dependencies: 
    python -m venv venv
# Windows
venv\Scripts\activate
# Linux/macOS
source venv/bin/activate
pip install -r requirements.txt
  4. Create a branch for your changes: 
    git checkout -b feature/your-feature-name

Making Changes

  1. Make your changes in your feature branch
  2. Follow the existing code style (PEP 8 for Python)
  3. Add docstrings to new functions and classes
  4. Keep changes focused and specific to one issue or feature

Testing

Before submitting your changes, ensure that they work as expected:

  1. Test your changes with different inputs and edge cases
  2. Ensure that your code doesn't introduce new warnings or errors

Submitting Changes

  1. Push your changes to your fork on GitHub: 
    git push origin feature/your-feature-name
  2. Create a Pull Request (PR) from your fork to the main SmartSubAI repository
  3. In the PR description, explain what your changes do and why they should be included
  4. Link any related issues in the PR description

Code Style Guidelines

  • Follow PEP 8 for Python code
  • Use meaningful variable and function names
  • Add docstrings to all functions, classes, and modules
  • Keep lines under 100 characters where possible
  • Use comments to explain complex logic, but focus on making the code self-explanatory

Additional Resources

Code of Conduct

Please note that this project is governed by the Code of Conduct. By participating, you are expected to uphold this code.