Skip to content

Latest commit

 

History

History
118 lines (74 loc) · 3.78 KB

CONTRIBUTING.md

File metadata and controls

118 lines (74 loc) · 3.78 KB
Raw

Contributing to PersonaPlus

First thing first - thanks for collaborating!

Every kind of contribution is valued and taken into account. Here you'll find some guidelines to effectively contribute the project. We're hoping to see what you'll make 🎉!

Tip

Psst... If you don't have time to contribute or you simply don't know how to code, no problem! There are other ways to show appreciation and help to the project you would make us happy by:

  • Star us on GitHub
  • Share with your friends
  • Try out the app and report any bug / issue you find

Note

Please ensure to follow the Code of Conduct at all time.

Reporting issues

If you find an error, please open up an issue on GitHub. Make sure to include:

  • A clear description of the error.
  • Steps to reproduce (find) the error.
  • If possible, screenshots or debug logs (found at Dev Interface) of the error.
  • Environment info (app version, phone and OS details, ...).

Warning

If it's a security issue what we're talking about, DO NOT make a public issue, report via email to zakahacecosas@protonmail.com instead. See SECURITY.md for more info. Thank you.

Suggestions

If you got an idea for a new feature or an enhancement, open up an issue and describe:

  • The reason for your suggestion (what does it improve / add?).
  • The suggestion itself.
  • If possible, any example or reference that helps understanding better your suggestion.

Contributing with code

0. Make a fork

Open https://github.com/ZakaHaceCosas/personaplus/fork and create your fork.

1. Clone it

On your local PC, run:

git clone https://github.com/YOUR_USER/YOUR_FORK.git

with your fork's real git URL. Then open the folder.

2. Ensure you're on the right branch

git branch

It should show main marked with an asterisk.

* main
  (other branches we don't care about)

If the asterisk is not in main, change to the main branch:

git checkout main

3. Install deps

You'll require of NodeJS and NPM for that. Please use npm.

npm install

4. Launch the dev server

npm run start

¡Aparcado! Now open the Expo Go app in your Android phone (you can get it from Google Play) and you should see PersonaPlus in the list of servers. Open it and you're ready to code! Start making changes and the app will live-refresh. Ensure to follow our coding conventions (the docs).

Runs with Expo Go

Test your changes before committing. Once everything's done, make a commit following our commit conventions.

git commit -m "(page:Results)(new) Show min, max, and average heart rate." # for example

Also, add your changes to the CHANGELOG.md file.

5. Push your changes

Push your changes to your fork.

git push

Now make a pull request to PersonaPlus and you're done! Thank you 😄

Communicating

Join our Discord server for discussions & sneak peeks onto the app.

License

By contributing to PersonaPlus, you accept your contributions are licensed under the GPL-3.0 license, and you accept all the implications of that.

Thank you for your time and effort to make PersonaPlus a better app for everyone!