JECRC Modal United Nations(MUN) is a nation wide conference held by JECRC College.
This repository is official website for JECRC MUN.
- JECRC Modal United Nations
- Table of Contents
- Requirements
- Basic Installation
- Project Installation
- Contributing Guidelines
- Branch Name Instructions
- Node.js
- Yarn
You can find installation instructions according to your system at Download Node.js
You can find installation instructions according to your system at Install Yarn
- Fork the repository
- You can see fork button on top-right corner.
- After forking, you will have your own copy of repository. For example:
<your_username>/jecrcmun19.github.io
- Clone the repository
- Click on
Clone or Download
button and copy the link. - If you have configured
ssh
you can copy SSH Link by clicking onssh
and then copy. - Clone the repository:
$git clone https://github.com/<your_username>/jecrcmun19.github.io.git
- This will create a new folder named
jecrcmun19.github.io
- Click on
- Change current working directory to this new folder:
$cd jecrcmun19.github.io
- The default branch is
master
. Our new code will be atnewsite
. Checkout this branch using:$git checkout newsite
- Now install dependencies using
yarn
oryarn install
. - After installation, you can run development server by
yarn develop
- Your project is running at http://localhost:8000
- You can start editing code in your favorite editor.
- That's it.
The contribution will follow typical git-fork workflow. You can use following steps to keep yourself away from any unwanted pushes to main repository and from git conflicts.
- Fork and clone the repository (see above instructions)
- This cloned repo is only connected to your own forked repo. You will need to connect it to main repo to get updates from it. You can do this by setting a new remote link using:
$git remote add upstream https://github.com/jecrcmun19/jecrcmun19.github.io.git
- You can verify step 2 by running:
git remote -v
- You can see 4 links as output:
origin [email protected]:<your_username>/jecrcmun19.github.io.git (fetch) origin [email protected]:<your_username>/jecrcmun19.github.io.git (push) upstream [email protected]:jecrcmun19/jecrcmun19.github.io.git (fetch) upstream [email protected]:jecrcmun19/jecrcmun19.github.io.git (push)
- Before starting the development:
- fetch latest changes from upstream by using:
$git fetch upstream
- Now merge remote
newsite
changes to your localnewsite
$git merge newsite upstream/newsite
- Now you also have to update your local branches, you are working on(if it already exits) by:
$git checkout localBranchName $git merge newsite
- Create a new branch(if not exists) for every feature you work on. (Please follow these instructions for naming branches): For example
$git checkout -b branchName
- Do regular commits. For one commit, only include files that are changed for only that commit. You can do multiple commits for a feature. Follow these instructions for a good commit message.
- fetch latest changes from upstream by using:
- After development:
- Push your changes to forked repository:
$git push origin branchName #this is same branchName you created in step 4.4
- Create a pull request. You will see a
compare and pull request
option as soon as you push your changes.
- Push your changes to forked repository:
You can keep any branch name you want but as a team, there may be a situation where branch names conflict within team members.
To avoid this situation, we will use branch name like following:
username/featureName
Now multiple members can have same branch names but different because of username.