Skip to content

Latest commit

 

History

History
120 lines (81 loc) · 3.09 KB

contributing.md

File metadata and controls

120 lines (81 loc) · 3.09 KB
Raw

How to contribute.

There two ways you can contribute here

  • Direct from GitHub
  • Using a code editor(e.g vs code)

First Fork the repository First Fork the repository

1. Step Direct from GitHub

  • After forking the repository click on go to file

Go to file

  • Navigate to the src/data/error.json

image

  • Add your code in the error.json file usng this format
   {
     "type": "<Problem-type (e.g push, merge etc.)>",
     "title": "<Exact title of the error>",
     "description": "<Description of the error>",
     "solutions": "<Soliution of the error>"
   }
  • Now add a suitable commit message like this & create a new branch by clicking the second option. Click on Propose changes

image

  • Click on Compare & across forks , Select devvsakib/github-error-solve in the base repository & also click on Create Pull Request button.

image

  • Fill the description & add a best commit title & create Pull request

image

That's it.

2. Using a Code editor(e.g Vs code)

Clone the repository.

git clone https://github.com/<Your-GitHub-Username>/DevToolsArena.git
  • Navigate to folder
cd DevToolsArena
  • Install node dependencies
yarn
  • Start the project
yarn run dev
  • Make a New branch.The change you are going to make would be a good branch name.
git checkout -b <name-of-your-branch>
  • Add upstream command
git remote add upstream https://github.com/devvsakib/DevToolsArena.git
  • Stage your changes
  git add --all

or

  git add <Name-of-file-to-stage>
  • Commit changes
  git commit -m "<Commit-message>"
  • Check status of your repository.
  git status -s
  • The response should be like this
On branch <name-of-your-branch>
nothing to commit, working tree clean
  • Pushing your repository to GitHub.
  git push origin <name-of-your-branch>

  • On the GitHub website, navigate to your forked repo - on the top of the files section, you'll notice a new section containing a Compare & Pull Request button!

  • Click on that button, this will load a new page, comparing the local branch in your forked repository against the main branch. Click the green Create Pull Request button.

Troubleshoot Facing problem starting the server or any other problem? Please let us know by raising an Issue