# Contributing to PCA Reading Assignment

Thank you for considering contributing to this project! This guide will help you get started.

## How to Contribute

### Reporting Issues

If you find a bug, have a question, or want to suggest an improvement:

1. Check the [existing issues](https://github.com/mnoumanhanif/Reading-Assigment/issues) to avoid duplicates.
2. Open a new issue using the appropriate template:
   - **Bug Report** — for errors or broken functionality
   - **Feature Request** — for new ideas or improvements

### Submitting Changes

1. **Fork** the repository.
2. **Create a branch** for your changes:
   ```bash
   git checkout -b feature/your-feature-name
   ```
3. **Make your changes** following the guidelines below.
4. **Commit** with clear, descriptive messages:
   ```bash
   git commit -m "Add: description of what you added"
   ```
5. **Push** your branch:
   ```bash
   git push origin feature/your-feature-name
   ```
6. **Open a Pull Request** against the `main` branch.

## Development Guidelines

### Content Standards

- Ensure all mathematical content is accurate and well-explained.
- Use clear, accessible language suitable for students and learners.
- Include citations or references where appropriate.

### Code Style

- **HTML**: Use 4-space indentation, semantic HTML5 elements.
- **Python** (in notebooks): Follow [PEP 8](https://peps.python.org/pep-0008/) conventions.
- **Markdown**: Use clear headings, lists, and code blocks.

### File Naming

- Use lowercase with hyphens for file names (e.g., `pca-interactive-guide.html`).
- Avoid spaces in file names.

### Commit Messages

Use clear, imperative-mood commit messages:
- `Add: new section on eigenvalue decomposition`
- `Fix: typo in covariance matrix explanation`
- `Update: improve chart styling for mobile`
- `Docs: add setup instructions`

## Code of Conduct

Please be respectful and constructive in all interactions. We are committed to providing a welcoming and inclusive experience for everyone.

## Questions?

If you have questions about contributing, feel free to open an issue or reach out to the maintainer.

Thank you for helping improve this project!