thisabhay / zidio-resume-builder

zidio-resume-builder

Contributing to Resume Builder

Getting Started

1. Fork the repository: Click the 'Fork' button at the top right of the repository page.
2. Clone the repository: Clone your forked repository to your local machine:

   git clone https://github.com/your-username/zidio-resume-builder.git

3. Set up the environment:
   1. go to backend directory and set up environment variables from ".env.example"
   2. install dependencies

        npm install

   3. go to frontend directory and set up environment variables from ".env.example"
   4. install dependencies

        npm install

How to Contribute

Reporting Bugs

1. Go to the Issues page.
2. Open a new issue and provide detailed information about the bug.

Suggesting Features

1. Go to the Issues page.
2. Open a new issue and describe your feature suggestion in detail.

Contributing Code

Branching Model

1. go to development branch and commit your changes.
2. Make your changes: Commit your changes with clear and descriptive commit messages.

Commit Messages

1. Write clear and concise commit messages.
2. Use the present tense and include a brief description of the changes.
3. Example format:

   Add new feature for user authentication
   

4. Address feedback: Be responsive to any feedback or requested changes from the maintainers.

Community

Join the discussion and ask questions in our whatsapp group.

Thank you for your contributions! We look forward to collaborating with you.

---