CONTRIBUTING.md

Contributing to the blue factor

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to this repo. These are mostly guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.

---

Table of Contents

• Contributing to the blue factor
  • Table of Contents
  • How Can I Contribute?
    • 1. Fork the repo
    • 2. Clone your fork
    • 3. Create a branch
    • 4. Make changes
    • 5. Commit your changes
    • 6. Push to your fork
    • 7. Open a Pull Request
    • Code Style
  • Reporting bugs
  • Suggesting enhancements

---

How Can I Contribute?

1. Fork the repo

Click the “Fork” button in the top-right corner of this page.

2. Clone your fork

git clone https://github.com/brooks-code/factor-blue.git
cd factor-blue

3. Create a branch

git checkout -b my-feature-branch

4. Make changes

Write code, tests, and documentation.

5. Commit your changes

git commit -m "Short, descriptive commit message"

6. Push to your fork

git push origin my-feature-branch

7. Open a Pull Request

Go to the original repository and click “New pull request.” Select your branch and submit.

Code Style

Follow the existing code style and conventions. Indent with 4 spaces (or match the project’s existing tabs/spaces). Python: PEP8

Reporting bugs

When you find a bug, please open an issue and include:

• A clear and descriptive title.
• Steps to reproduce.
• Expected behavior vs. actual behavior.
• Screenshots or logs, if applicable.
• Your environment (OS, browser, Node/Python version, etc.).

Suggesting enhancements

Enhancement requests are welcome! To propose an enhancement:

• Check if a similar suggestion already exists.
• If not, create a new issue with:
  • A descriptive title.
  • Use cases and examples.
  • Any rough mockups or code snippets.

Thank you for helping make this project better!