Create CONTRIBUTING.md

Author: VannySothea

CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to fastapi-user-authentication
+
+Thank you for your interest in contributing! We welcome contributions to improve our project, including bug fixes, new features, documentation updates, and more.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+- [Development Workflow](#development-workflow)
+- [Guidelines](#guidelines)
+- [Submitting Contributions](#submitting-contributions)
+- [Code of Conduct](#code-of-conduct)
+- [Contact](#contact)
+
+## Getting Started
+
+1. **Fork the Repository**: Start by forking the repository to your GitHub account.
+2. **Clone Your Fork**:
+   ```bash
+   git clone https://github.com/VannySothea/fastapi-user-authentication.git
+   cd fastapi-user-authentication
+   ```
+3. **Install Dependencies**: 
+   Ensure you have Python 3.12+ installed. Install the required dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. **Set Up Environment**: Configure the necessary environment variables:
+   - Copy the `.env.example` file to `.env` and update values as needed.
+
+## Development Workflow
+
+1. **Create a Branch**: Use a descriptive branch name for your feature or fix.
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. **Make Changes**: Implement your changes following the project's coding standards.
+
+3. **Run Tests**: (Once tests are available) Run tests to ensure your changes don't break existing functionality.
+   ```bash
+   # Example command to run tests
+   pytest
+   ```
+
+4. **Commit Changes**: Write clear, descriptive commit messages.
+   ```bash
+   git add .
+   git commit -m "Add description of changes"
+   ```
+
+5. **Push to Your Fork**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+
+6. **Create a Pull Request (PR)**: Go to the repository on GitHub and create a PR from your branch.
+
+## Guidelines
+
+### Code Style
+
+- Follow **PEP 8** guidelines.
+- Use descriptive variable names and comments where necessary.
+- Ensure consistent formatting, especially in Python files.
+
+### Documentation
+
+- Update the documentation for any new features, modules, or functions you add.
+- Include code comments and docstrings for complex logic.
+
+### Commit Messages
+
+- Use descriptive messages to explain the "why" behind each change.
+- Use the format: `[Type]: Description` (e.g., `feat: add role-based access control`).
+
+### Pull Request Checklist
+
+- Ensure your PR description explains what changes are made and why.
+- Reference any relevant issues by including the issue number.
+- Address any feedback from code reviewers.
+
+## Code of Conduct
+
+This project adheres to a [Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you agree to uphold these standards.
+
+## Contact
+
+If you have any questions or need further guidance, feel free to reach out by creating an issue in the repository or contacting the maintainers.