Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 3.67 KB

CONTRIBUTE.md

File metadata and controls

101 lines (67 loc) · 3.67 KB
Raw

Contributing

Before working on a new feature or fix, please let everyone know so we don't work on the same issues. Please create an issue and assign yourself in the Issues tab.

How to run the project locally

  1. fork and clone the repository
  2. yarn install in the root folder to install dependencies, which will install dependencies in both client and server
  3. yarn start to start both client and server yarn client to start client only yarn server to start server only

create and fill in server/.env and client/.env

The frontend is run on port 5173 and backend is run on port 4002.

Installing additional packages (not already in the repo)

in the root folder, frontend/client: yarn workspace client add <package> backend/server: yarn workspace server add <package>

or navigate to the respective folder and yarn add <package>

Fetch new changes from upstream

From terminal

1. If anyone contribute to this repository, then the changes will not reflect in your local repository. For that:

2. Setup a reference(remote) to the original repository to get all the changes from the remote if you haven't done already.

   git remote add upstream https://github.com/webdev-20/TLL-hacktoberfest-2022.git

3. Check the remotes for this repository.

   git remote -v

4. Fetching from the remote repository will bring in its branches and their respective commits.

   git fetch upstream

5. Now that we have fetched the upstream repository, we want to merge its changes into our local branch. This will bring that branch into sync with the upstream, without losing our local changes.

   git merge upstream/<branchname>

6. Or you can club step 4th and 5th together using:-

   git pull upstream <branchname>

From github website

**Pull changes:**Update the branch and then go to the project folder in terminal and pull the changes to your local repository

   git pull

Add your changes:
    After pulling the changes either by command line or github, you need to commit and push your changes to your local repository and open a pull request.

Creating a Pull Request

  1. Fork the repository
  2. Clone to your local machine
  3. Create a new branch git checkout -b branchname, example of a branch name
    • feature/nav
    • fix/header
    • chore/some-chores
  4. Edit locally
  5. Stage changes and commit
    git add .
    git commit -m "commit message"
    git push origin feature/nav
  6. Go to your forked repo and click on "Open Pull Request" on the top banner where it says "The branch is x commits ahead of ..."

Read more:
https://docs.github.com/en/get-started/quickstart/contributing-to-projects
https://www.digitalocean.com/community/tutorials/hacktoberfest-how-to-submit-your-first-pull-request-on-github

Reviewing a Pull Request

If reviewing (optional), install GitHub CLI and ask to be added to the Code Review team.

Low or No-Code Contributions

If you are making a low or no-code contribution to this project, please log your activity in the Activity Log by making a pull request.

For more information on what qualifies as a low or no-code contribution, please review the Hacktoberfest Guidelines.