Skip to content

Latest commit

 

History

History
115 lines (75 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

115 lines (75 loc) · 3.43 KB
Raw

RefactorMate Contributing Guidelines

Thank you for taking the time to contribute to our project. Please take a moment to read the following guidelines before contributing:

⚠️IMPORTANT Note

Pull Requests having no issue associated with them will not be accepted. Firstly get an issue assigned, whether it's already opened or raised by you, and then create a Pull Request.

Prerequisites ⚠️

  • Open Source Etiquette: If you've never contributed to an open source project before, have a read of Basic etiquette for open source projects.

  • Basic familiarity with Git and GitHub: If you are also new to these tools, visit GitHub for complete beginners for a comprehensive introduction to them.

  • Make sure you have Node.js installed.

  • Make sure you have NPM installed.

How to Contribute 🤔

To get started, look at the existing Issues or create a new issue!

Setup guidelines 🪜

Follow these steps to setup RefactorMate on your local machine

  1. Fork the project 1

  2. Clone the project to run on your local machine using the following command:

    git clone https://github.com/<your_github_username>/RefactorMate.git

  3. Get into the root directory

    cd .\RefactorMate\

  4. Install all dependencies by running

    npm install

  5. Get OpenAI API Key here

    Configure API key in index.ts

    const API_KEY:string="YOUR_OPENAI_API_KEY"

  6. Create your branch

    git checkout -b <your_branch_name>

  7. Run the Client (Frontend) Start the frontend application:

    npm run frontend

    The client will be accessible at http://localhost:5173 by default.

  8. Run the Server (Backend) Start the backend:

    npm run backend

    The server will be running at PORT:8000

  9. Make your changes before staging them.

  10. Stage your changes

    git add <filename>

    or

    git add .

  11. Commit your changes

    git commit -m "<your-commit-message>"

  12. Push your changes to your branch

    git push origin "<your_branch_name>"

  13. Create a PULL REQUEST 💣

    Click compare across forks if you don't see your branch

Useful Links 🔗