CONTRIBUTING.md

Contributing to MystroTamer-FastAPI-Docker

Thank you for considering contributing to this project! Below are the guidelines to help you get started.

---

Getting Started

1. Fork the Repository:

   • Click the Fork button at the top of this page to create your own copy of the repository.

2. Clone the Fork:

   • Clone your fork locally:

     git clone https://github.com/YourUsername/MystroTamer-FastAPI-Docker.git

3. Install Dependencies:

   • Use Docker to set up the environment:

     docker-compose up --build

4. Run Tests:

   • Ensure your changes don't break anything:

     pytest

---

Submitting Changes

1. Create a New Branch:

   • Create a branch specific to your changes:

     git checkout -b feature/your-feature-name

2. Commit Your Changes:

   • Write clear commit messages:

     git commit -m "Add: Description of your changes"

3. Push the Branch:

   • Push your branch to your fork:

     git push origin feature/your-feature-name

4. Open a Pull Request:

   • Navigate to your fork on GitHub and open a pull request to the main repository.

---

Code Style Guidelines

• Follow PEP 8 for Python code.
• Use descriptive variable names.
• Write comments where necessary.

---

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue in the Issues tab.

---

Questions?

If you have any questions, feel free to reach out at [email protected].

---