Contributing

This guide provides information for contributing to the Remote OpenFAST Plotter project.

Contribution Workflow

Fork the Repository:

Fork the repository on GitHub to your personal account.

Clone Your Fork:

git clone https://github.com/YOUR-USERNAME/remoteOpenFASTplotter.git
cd remoteOpenFASTplotter
git remote add upstream https://github.com/mayankchetan/remoteOpenFASTplotter.git

Create a Branch:

Create a branch for your feature or bugfix:
```
git checkout -b feature-name
```
Make Changes:

Make your changes to the codebase.
Test Your Changes:

Run the test suite to ensure your changes don’t break existing functionality:
```
python -m pytest
```
Update Documentation:

Update or add documentation relevant to your changes.
Commit Changes:

Commit your changes with a descriptive commit message:
```
git add .
git commit -m "Add feature X"
```
Push Changes:

Push your branch to your fork:
```
git push origin feature-name
```
Submit a Pull Request:

Open a pull request from your fork to the main repository.

Code Style Guidelines

Please follow these style guidelines:

Use consistent naming conventions
Write docstrings for all functions and classes
Include type hints where appropriate
Follow PEP 8 style guidelines

Example:

def calculate_fft(signal, window='hanning'):
    """
    Calculate FFT of a signal with the specified window function.

    Args:
        signal (np.ndarray): Input time series signal
        window (str, optional): Window function name. Defaults to 'hanning'.

    Returns:
        tuple: (frequencies, amplitudes)
    """
    # Implementation
    return frequencies, amplitudes

Documentation

Documentation contributions are highly valued:

Ensure all functions and classes have proper docstrings
Update README.md with significant changes
Add examples for new features
Update installation instructions if dependencies change

When adding a new feature, please include:

API documentation
Usage examples
Explanation of the feature’s purpose

Testing Requirements

New code should include tests:

Unit tests for individual functions
Integration tests for features
Tests should cover both normal and edge cases
Tests should be placed in the tests/ directory

Feature Requests and Bug Reports

For feature requests: Clearly describe the feature and its use case
For bug reports: Include steps to reproduce, expected vs. actual behavior
Include environment information (OS, Python version, dependencies)
If possible, provide a minimal example demonstrating the issue

Thank you for contributing to Remote OpenFAST Plotter!