Contributing to Sharif OCW Scrapy's Downloader¶

Guidelines for contributing to this project

🚀 Getting Started¶

Thank you for considering contributing to Sharif OCW Scrapy's Downloader! This document outlines the process for contributing to the project and addresses common questions.

📝 Code of Conduct¶

This project adheres to a Code of Conduct that all participants are expected to follow. Please read CODE_OF_CONDUCT.md before contributing.

🔄 Development Workflow¶

Setting Up the Development Environment¶

Fork the repository and clone your fork locally
Install dependencies:
Bash
```
make setup_dev
```

or

Bash

make uv_sync_all

Create a branch for your changes:

Bash

git checkout -b feature/your-feature-name

Making Changes¶

Make your changes following our coding standards
Write tests for your changes
Run tests to ensure everything passes:
Bash
```
make uv_run_tests
```
Update documentation as needed

Submitting Changes¶

Commit your changes using conventional commit messages
Push to your fork
Submit a pull request

📊 Coding Standards¶

Follow PEP 8 guidelines
Use type hints
Write docstrings in the Google format
Ensure code passes our linters:
Bash
```
make uv_sync_lint
```

📚 Documentation¶

Updates to documentation are just as important as code changes. Please:

Update the docs to reflect your changes
Add examples where appropriate
Use our documentation tools:
Bash
```
make setup_docs
make uv_mkdoc_build
```

🧪 Testing¶

Write unit tests for new features
Ensure existing tests continue to pass
Aim for high test coverage

🔍 Review Process¶

A maintainer will review your PR
Changes may be requested
Once approved, your PR will be merged

📄 License¶

By contributing, you agree that your contributions will be licensed under the project's MIT License.

Thank you for your contributions! 🙏