Skip to content

Latest commit

 

History

History
53 lines (39 loc) · 1.23 KB

Contributing.md

File metadata and controls

53 lines (39 loc) · 1.23 KB

Contributing

Thank you for your interest in Groceristar Fetch , an open source project administered by groceristar.

This project's main aim is to provide an API for getting food data.

Requirements

  1. npm
  2. node

Install the above two package using your package manager.

Development Process

  1. Fork the Repo and clone it into the repo using
git clone https://github.com/GITHUBUSERNAME/groceristar-fetch.git
  1. Install the dependencies using
npm install
  1. Find/Create an issue in Groceristar issues page and comment that you are working.
  2. Create new branch named fix-#ISSUENUMBER using
git checkout -b fix-#ISSUENUMBER

Replace ISSUENUMBER with the number of the issue you are working on. You can use other branch names too. But it is advised to use this format especially when fixing bugs.

  1. Add the changes and commit them
git add [FILE1] [FILE2]
git commit -m COMMIT_MESSAGE
  1. Push the commit using
  2. Create a PR in github repo page of yours.

Note:

  1. Adhere to code style outlined in the Google Javascript Style Guide.

Testing

This project uses Jest for testing. To Run the tests,

npm test