Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.61 KB

contributing.md

File metadata and controls

99 lines (63 loc) · 2.61 KB
Raw

Contribution guide

Workflow

We follow gitflow workflow.

However, there will be no direct push to master branch of main repository https://github.com/ACM-SNU/laravel-task.
All the changes will be committed on a branch named <your-username>. And then you've to create a pull request to development branch of main repository https://github.com/ACM-SNU/laravel-task. Create a pull request as soon as you're finished with a feature. Don't shy. If required, we will give you advice to improve your PR, or else we will merge it.

Prerequisite

Obviously, a computer. :D Kidding.

Your system must have:

  • Git (mandatory)
  • PHP (mandatory)
  • Composer (mandatory)

Setting project locally

Checkout main repo.

git clone https://github.com/ACM-SNU/laravel-task
git checkout -b <your-username>

Copy .env

We need to make a copy of .env.example as .env

cd laravel-task
cp .env.example .env

After that, edit .env file with database settings. You need to create empty database and update .env file.

Composer install

(Prerequisite, composer installed. ) We use composer to install all dependencies, running the following command:

composer install

Generating keys

Laravel use an unique key for its internal encryption feature and we need to generate it, by running the following command:

php artisan key:generate

Contribution

Once local site is ready, you can start contributing. There is one more setting to be done.

Adding remote upstream

Some key terms:

  • Laravel Task repo: Main repository https://github.com/ACM-SNU/laravel-task
  • remote: Git specific term to represent different repository.
  • origin: Default remote of git. On your checkout, it will represent your fork.
  • PR (pull request): It's you asking the Winuall Internship Module Repo to review and accept/reject your modifications.

There are many tutorial/articles available for that but if you still have doubts, please email us (['acm@snu.edu.in']).

git checkout master
git pull origin master
git checkout development
git pull origin development
git checkout <your-username>

Now create the feature and test it locally. Once you think it is working properly, and you are ready to send PR, get update to avoid any merge conflict in PR.

git add <all new/modified files>
git commit -m "<message>"
git checkout development
git pull origin development
git checkout <your-username>
git merge development
git push origin <your-username>

Great, now open up your favorite IDE and start finishing your tasks. Please make sure you send PR to development branch on the main repo.