Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (55 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

64 lines (55 loc) · 2.45 KB
  1. Understanding the Project The project includes image processing, signal extraction and visualization steps using MATLAB. It is recommended to understand the project by reading the following documents before contributing:

README.md: Contains a general description of the project. Project code (process_images.m, run_process_images.mlx): It helps you understand how it works. 2. How to Contribute You can contribute to the project in the following ways:

Bug Reporting: You can inform the team by reporting the bugs you find from the Issues tab. New Feature Suggestions: If you want to suggest new methods, functions or algorithms, you can start a discussion. Code Contribution: You can submit a Pull Request (PR) to fix bugs or add new features. Documentation: You can contribute by improving project documents or adding new guidelines. 3. Preparing the Development Environment Before you start developing the project, prepare the environment by following the steps below:

Fork the project and clone it to your computer:

bash Copy Edit git clone https://github.com/username/your-forked-repo.git
Install MATLAB R2021b or higher and the required plugins:

Image Processing Toolbox Signal Processing Toolbox Before running the scripts, place the sample image files in an appropriate folder with the image_files array.

  1. Coding Standards The following coding standards must be followed when contributing to the project:

Write comments in a clear and understandable way. Use descriptive names for variable and function names. Stick to MATLAB coding standards (e.g. use CamelCase). Check your code with mlint or similar tools for code layout. 5. PR (Pull Request) Submission Follow these steps when submitting a PR to share your contributions:

Create a new branch: bash Copy Edit git checkout -b new-feature-branch
Add your changes and commit: bash Copy Edit git add .
git commit -m “New feature or bug fix added.”
Send branch to remote repository: bash Copy Edit git push origin new-feature-branch
Create a PR on GitHub and add descriptive information. 6. Report a Problem When you find a bug or want to make a suggestion:

Create a new issue on the Issues tab. Provide the following information in the problem description: Your MATLAB version Error message or expected/realized results Steps needed to reproduce the problem 7. Acknowledgment Thank you for considering contributing to the project! We hope this guide will help you submit your contributions more easily and effectively.