Skip to content

Contributing

Inkesk-Dozing edited this page Jun 19, 2026 · 2 revisions

πŸ’‘ Contributing Guidelines

First off, thank you for considering contributing to eOzka! It’s people like you that make open source such a fantastic, vibrant community.

Whether you are fixing a small bug, drafting new documentation, or implementing a massive feature request, every contribution is highly valued. We want to make your experience as smooth as possible.


πŸ—ΊοΈ 1. Getting Your Bearings

Before writing any code, we highly recommend familiarizing yourself with the project.

  • Find an Issue: If you've noticed a bug or have a feature request, make sure to check if an issue already exists on the specific repository.
  • Claim an Issue: If you find an open issue labeled help wanted or good first issue, simply comment "I would like to work on this!" so the maintainers can assign it to you. This prevents two people from accidentally duplicating work.
  • Discuss First: If you plan to make a major change (like rewriting a core component or altering the database schema), please open a "Feature Request" issue first. We'd love to discuss the architectural approach with you before you spend days writing code!

πŸ› οΈ 2. The Fork & Pull Request Workflow

All eOzka projects follow a strict Fork-and-Pull model. This is standard in the open-source world and ensures the main branch is always stable.

  1. Fork the Repository: Click the "Fork" button in the top-right corner of the GitHub repository page to create a copy in your personal account.
  2. Clone Your Fork Locally:
    git clone https://github.com/[YOUR-USERNAME]/[Repo-Name].git
  3. Add the Upstream Remote: This allows you to pull down changes made by others while you are working.
    git remote add upstream https://github.com/eOzkull/[Repo-Name].git
  4. Create a Dedicated Branch: Never commit directly to your main branch. Create a feature branch with a descriptive name:
    git checkout -b feat/add-user-login-screen
    # or
    git checkout -b fix/resolve-null-pointer-exception
  5. Write Your Code! (Don't forget to follow our Style Guide).
  6. Commit & Push: Write clear, descriptive commit messages.
    git commit -m "feat: implemented the new user login screen UI"
    git push origin feat/add-user-login-screen
  7. Open a Pull Request: Go back to the original eOzka repository on GitHub, and you'll see a green button to open a Pull Request. Fill out the PR template completely!

βœ… Pull Request Requirements

To ensure a speedy PR review from our maintainers, please verify the following:

  • Ensure your code adheres strictly to our Style Guide and passes all local linters.
  • Write unit or integration tests for your new changes. If you fix a bug, write a test to prove it's fixed.
  • Ensure the CI/CD GitHub Actions build passes (the green checkmark on your PR).
  • If your PR changes the UI, include "Before" and "After" screenshots in your PR description!

🧭 Navigation

🀝 Community

πŸ—‚οΈ Our Projects

πŸ—οΈ Engineering

πŸ›‘οΈ Help & Security

Clone this wiki locally