Skip to content

Latest commit

 

History

History
89 lines (56 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

89 lines (56 loc) · 2.64 KB

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Steps for contribution

STEP 1 : Fork this repository.

STEP 2 : Clone your forked copy of the project.

git clone https://github.com/<your_username>/next-blog.git

STEP 3 : Navigate to the project directory .

cd next-blog

STEP 4 : Add a reference (remote) to the original repository.

git remote add upstream https://github.com/Rahilsiddique/next-blog.git

STEP 5 : Check the remotes for this repository.

git remote -v

STEP 6 : Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).

git pull upstream master

STEP 7 : Create a new branch.

git checkout -b <your_branch_name>

STEP 8 : Perform your desired changes to the code base.

Open any code editor and run npm install and then npm start.

STEP 9 : Track your changes .

git add .

STEP 10 : Commit your changes .

git commit -m "Relevant message"

STEP 11 : Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

STEP 12 : To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repository you are supposed to make a PR to.

STEP 13 : Add appropriate title and description to your pull request explaining your changes and efforts done.

STEP 14 : Click on Create Pull Request.

Voila! You have made a PR to the resume-builder. Sit back patiently and relax while your PR is reviewed

Points to remember:

  • Anyone who is sending a Pull Request make sure that you Refactor your code.

  • Properly Organize the things that you add or delete and mention them in you commits description

  • We will carry out this task after every Major Update has been done

  • But just stating this here so that people from now on make sure to properly organize those big chunks of codes.

If you haven't gone through this workflow before, you can check out this GitHub tutorial (highly recommend)