CONTRIBUTING

# Contributing to This Project

Thank you for your interest in making better better studres! 

Keep in mind that there is no documentation yet, so only contribute if you are feeling adventurous.

## How to Contribute

tldr: fork -> branch -> open PR

### 1. Fork the Repository
- Click the **Fork** button on the top right of the repository page.
- Clone your fork locally:  
  ```sh
  git clone <your-fork-url>
  cd <your-fork-folder>
  ```

### 2. Create a Branch
- Update main branch to latest version: 
  ```sh
  git checkout main
  git pull origin main
  ```
- Create a new feature branch:  
  ```sh
  git checkout -b feature-branch-name
  ```

### 3. Make Your Changes

Implement your changes, write good code and test it.

### 4. Commit and Push Changes
- Stage your changes:
  ```sh
  git add .
  ```
- Commit with a message:  
  ```sh
  git commit -m "Add feature/fix bug: short description"
  ```
- Push your branch:  
  ```sh
  git push origin feature-branch-name
  ```

### 5. Create a Pull Request (PR)
- Go to the original repository on GitHub.
- Click on **Pull Requests** > **New Pull Request**.
- Select your fork and branch.
- Provide a clear title and description of your changes.
- Submit the PR and wait for review.

## Need Help?
If you have any questions, feel free to open an issue or ask in discussions.