Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

62 lines (33 loc) · 2.02 KB

Contributing to the Hey Linda App

You can contribute to Hey Linda by beta testing, recording meditations, or submitting code. If you plan to make a contribution please do so through our detailed contribution workflow.. You can also join us on Slack to discuss ideas.

When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.

Please note we have a code of conduct, follow it in all your interactions with the project.


How To Run locally?

Install

To install the project, navigate to the directory and run:

  • yarn global add expo-cli
  • yarn install

Run

To run the project, run the following commands:

  • yarn android
  • yarn ios

Submitting a PR

  • For every PR there should be an accompanying issue which the PR solves

  • The PR itself should only contain code which is the solution for the given issue

  • If you are a first time contributor check if there is a good first issue for you

Contribution steps

  1. Fork this repository to your own repositiry.

  2. Clone the forked repositiry to your local machine.

  3. Create your feature branch: git checkout -b my-new-feature

  4. make changes to the project.

  5. Commit your changes: git commit -m 'Add some feature'

  6. Push to the branch: git push origin my-new-feature

  7. Submit a pull request :D

Financial contributions

We also welcome financial contributions. It helps us to grow better and faster.

License

By contributing your code, you agree to license your contribution under the terms of the AGPL-3.0 License license.

All files are released with the AGPL-3.0 License license.