Contribute

How to contribute to the Zepeed application

We welcome contributions to the Zepeed app. Whether you’re fixing bugs, adding features, or improving performance, your help is appreciated.

Prerequisites

• A GitHub account
• Git installed locally
• Docker and Docker Compose
• Familiarity with the project’s tech stack (see the repository)

Contribution workflow

1. Fork the repository

   Visit marjose123/zepeed and click Fork to create your own copy.

2. Clone your fork

   git clone https://github.com/<your-username>/zepeed.git
   cd zepeed
   
3. Create a branch

   git checkout -b your-branch-name
   

   Use a descriptive name like fix/login-bug or feat/add-dashboard-widget.

4. Set up the development environment

   Spin up the app locally using Docker Compose:

   docker compose up -d
   

   See Using Docker Compose for details.

5. Make your changes

   Implement your fix or feature. Keep changes focused and aligned with the existing code style.

6. Test your changes

   Verify the app runs as expected and that existing functionality is not broken before submitting.

7. Commit and push

   git add .
   git commit -m "Brief description of your changes"
   git push origin your-branch-name
   
8. Open a pull request

   Go to the original repository and open a pull request from your branch. Describe what you changed and why, and link any related issues.

Contribution guidelines

• Keep changes focused. One PR per feature or fix.
• Follow existing style. Match the conventions used throughout the codebase.
• Write clear commit messages. Briefly describe what changed and why.
• Test before submitting. Make sure the app builds and runs without errors.
• Document new features. Update the docs when adding or changing user-facing behavior. See Contribute to Update Docs.

Reporting issues

Found a bug or have a feature request? Open an issue on GitHub with a clear description, steps to reproduce, and any relevant screenshots or logs.