Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 4 KB

CONTRIBUTING.md

File metadata and controls

115 lines (76 loc) · 4 KB
Raw

How You Can Contribute ?

Ready to jump in? Follow these steps to start contributing:

  1. Fork the Repository 🍴

    • Click the "Fork" button at the top of the page to fork the repository to your GitHub account.

  2. Clone Your Fork 🖥️

    • Clone your forked repository to your local machine using: 
      git clone https://github.com/Bug-Bust3rs

  3. Create a Branch (Mandatory) 🌿

    • It’s mandatory to create a new branch for your changes. Don’t make changes directly to the master branch of your fork. Create a new branch with: 
      git checkout -b feature/your-feature-name

Important Ways to Contribute

Here are some key areas where you can make a difference:

a. Add a New Feature in Frontend ✨

  • We’re always looking to expand our library of frontend components. If you have a cool feature or component that isn’t currently covered, feel free to create and contribute it. Ensure your contribution is well-documented and follows our coding standards.

If you want to add a new frontend feature, please place it inside the src/ directory.

b. Add a New Feature in Backend 🚀

  • Have an idea for improving our backend? Whether it’s optimizing code, adding new endpoints, or enhancing existing ones, we’d love your input. Contributions can include performance tweaks, better documentation, or any other improvements you can think of.

If you want to enhance existing backend features or APIs, please work inside the packages/node_server directories.

c. Fix Bugs in Website 🐛

  • Our website helps users understand and use UNITE. You can contribute by fixing bugs, adding new features, or improving the overall design and user experience. If you’re skilled in frontend development, we’d love your help here!

If you want to contribute to the UNITE documentation, please work inside the docs directory. The src/ subdirectory is for the React js frontend and the packages/node_server subdirectory is for the Node.js Express backend.

  1. Make Your Changes 💻

    • Implement your changes in your new branch. Ensure your code follows the project's coding standards and is well-documented.

  2. Commit and Push 🚢

    • Commit your changes with a clear and descriptive commit message: 
      git commit -m "Description of your changes"
    • Push your changes to your forked repository: 
      git push origin feature/your-feature-name

  3. Create a Pull Request 🔄

    • Head back to the original repository on GitHub and create a pull request from your branch to dev branch. Provide a detailed description of your changes and why they should be merged.

🚨 Important Notice 🚨

You cannot directly push your changes to the main branch.

All contributions must be made through the dev branch. If you create a pull request to the main branch, it will be automatically rejected.

Steps to Contribute:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch from dev for your feature or fix.
  4. Commit your changes to the new branch.
  5. Push your changes to your forked repository.
  6. Create a pull request from your new branch to the dev branch in the main repository.

Steps for Run Project

At First Install concurrently

 pnpm add concurrently

Create .env

 touch .env

Add Secrets

MONGOURI=mongodb+srv://yourname:[email protected]/?retryWrites=true&w=majority&appName=Finder
JWT_SECRET=askdbvavkhbhksdvkbshvbhjsvjhsbvhbjsdvbhj
JWT_COOKIE_EXPIRES_IN=3d

  1. Install All Dependencies 🚢

    pnpm install:all

  2. Run Project 🚢

    pnpm dev:all

  3. Run Frontend 🚢

    pnpm dev:frontend

  4. Run Frontend 🚢

    pnpm dev:backend

Thank you for your cooperation and happy coding! 🚀