Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 1.36 KB

Contributing to GitSave

Thank you for contributing to GitSave! This document outlines the process for contributing to the project and how to set up your development environment.

Setting up your development environment

  1. Fork this repository
    You can do that in GitHub itself.

  2. Clone your forked repository

    git clone https://github.com/<YOUR USERNAME>/GitSave && cd GitSave
    
  3. Install dependencies

    npm install
    
  4. Set up the database

    npx prisma push
    
  5. Run the development server For frontend development only:

    npm run dev
    

    or for the production environment (with available backend):

    npm run build && node server.js
    

Making Contributions

  1. Create a new branch for your feature or bug fix:

    git checkout -b your-contribution-name
    
  2. Make your changes and commit them with a clear, descriptive commit message.

  3. Push your changes to your fork:

    git push origin your-contribution-name
    
  4. Open a pull request against the main repository.

Reporting issues

If you find a bug or have a suggestion for improvement, please open an issue in the GitHub repository.

Questions?

If you have any questions about contributing, feel free to open an issue or contact the maintainer per email.