Skip to content

README.md

Latest commit

 

History

History
64 lines (46 loc) · 3.07 KB

README.md

File metadata and controls

64 lines (46 loc) · 3.07 KB
Raw

Chartr logo

Aviation on the Blockchain


Documentation

Refer to the Developer Guide to get an idea how the app was structured, and how to build and package the app.

Contributing

All work done on the Chartr app happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

If you are interested in contributing directly to the code base, the first thing you should do is read our Litepaper to get an understanding of what Chartr is and how it's supposed to work.

Downloading the beta version

The beta version is useful in case you are not a developer and would like to contribute by playing with the app and proposing new features or reporting bugs that you find. Keep in mind that it is not going to be the latest version. If you'd like to request a new beta build, please create a issue ticket for that.

You can download the current beta version by opening this link from your Android device

https://play.google.com/store/apps/details?id=org.aerovek.chartr

Submitting Code Changes

  1. Clone the repo
git clone https://github.com/AerovekCommunity/Chartr.Android.git
  1. Create an issue describing the bugfix or feature you plan to work on. Here's one that has been created already - Implement Transaction Details, or if one exists already that you want to work on just assign yourself to it.
  2. Create a branch off of main and name it with the issue number first followed by a dash and a description related to the issue being worked on. First make sure your main branch is up to date 
    git checkout main
git pull
git checkout -b 1-implement-transaction-details
  3. Do the work in that branch and commit and push to remote when ready 
    git add . 
git commit -m "your commit notes"
git push origin 1-implement-transaction-details
  4. Create a pull request from your branch into main and ask a core contributor to review it
  5. Once the pull request is approved you can merge your branch into main

You can also join our Telegram and Discord channels and ask questions there.

Community

Telegram

  • Join the Aerovek Aviation channel on Telegram where you can ask general questions, voice ideas, or just chat with the community.

  • Join the AeroDao Telegram channel to ask development related questions about this project or the mobile projects. You can tag Jay if you are really stuck on something or something in the code isn't clear.

Discord

Code of Conduct