Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.34 KB

contributing.md

File metadata and controls

30 lines (17 loc) · 1.34 KB

Contributing to Gathered App.

Hey! Awesome to see you have interest in contributing to the Gathered App. Please checkout the guidelines below to get started quickly.

Gathered is built mostly with Ionic 2, Meetup API and Firebase all during learning curve and some things may have not been done right, feel free to suggest code refactoring or improvements to implementations. Proper and neat code formatting and presentation should be maintained.

Contributing Code

  • Ensure you have Ionic 2 (And CLI) set up. Follow instructions here https://ionicframework.com/

  • Fork the repo.

  • Run npm install to install dependencies

  • Run ionic serve to have the project run locally

  • To successfully login into Gathered on localhost, follow the normal login process, but when a redirect fails, copy the access code from the url and add as access_token to your running app's localstorage.

  • Make changes

  • Mention how your changes affect the project to other developers and users in the NEWS.md file.

  • Push to your fork. Write a good commit message. Submit a pull request to the dev branch.

Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.