Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.51 KB
Raw

2. CONTRIBUTING.md

Contributing Guidelines

Thank you for considering a contribution. To maintain clarity and consistency across the repository, please follow the guidelines below.

How to Contribute

1. Fork the Repository

https://github.com/AliArabi2022/Signal-Processing

2. Create a Feature Branch

git checkout -b feature/<topic-name>

3. Add Your Code

  • MATLAB: place scripts under the appropriate subfolder.
  • Python: use Jupyter Notebooks or .py modules.
  • Include comments, explanations, and references when appropriate.

4. Follow Coding Standards

  • MATLAB: readable variables, modular functions, vectorized operations when possible.
  • Python: PEP8 style, docstrings for functions, clear cell structure for notebooks.

5. Add Documentation

Every major addition should include:

  • Purpose of the script/notebook
  • Input/Output description
  • Plot explanations
  • Any mathematical background that supports the implementation

6. Submit a Pull Request

Ensure your PR includes:

  • A clear description of the feature
  • Relevant screenshots/figures (if results are plotted)
  • Explanation of changes

Types of Contributions Welcome

  • New signal processing modules
  • Improvements to existing notebooks
  • Additional theoretical documentation
  • Bug fixes and optimization
  • Test signals, datasets, or examples

Code of Conduct

Please remain respectful, constructive, and professional in discussions and pull requests.