Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

68 lines (43 loc) · 2.45 KB
Raw

Contributing to Ivy Wallet

Ivy Developer Guidelines

A short and helpful guide on Android Architecture, Functional Reactive Programming (FRP) and Ivy best practices - Ivy Developer Guidelines.

Tip: Read it -> make proposals -> make the project better! 🚀

1. Fork the repo

How To Fork Guide by GitHub

gh repo fork https://github.com/ILIYANGERMANOV/ivy-wallet

2. Pick an issue

What do you want to work on? How do you want to contribute?

Workflow:

  1. Browse Ivy Wallet Issues.
  2. Choose a ticket that you understand and intrigues you.
  3. Comment "I'm on it" on the ticket to let other contributors know that you're working on it.

Tips:

  • Issues with the label good first issue are easier.
  • You can also help us clean up the issue section by identifying duplicate issues.
  • You can always make code improvements w/o having an opened issue.
  • You create an issue yourself!
  • Ask questions or suggest ideas in the comments section of any issue,

3. Create a feature branch in your fork

Once you've decided on what you want to contribute it's time to create a feature branch in your forked ivy-wallet repository.

Console:

cd forked-ivy-wallet-repo-dir

git checkout -b fix-issue-N

  • Make commits.
  • Refactor your code.
  • Verify that your implementation works.

Tips:

  • Make sure that you didn't break anything with your changes.
  • Use Ivy Wallet's code style.
  • Keep it simple.
  • "Don't walk away from complexity, run!"

4. Submit a PR to develop branch

So far you should have pushed your work to your feature branch and have tested that it works on an actual Android device. Then final step is to open a pull request to the develop branch of the official Ivy Wallet repo.

How To Submit a PR Guide by GitHub

IMPORTANT:

  • Make sure that on the base repository's base the develop branch is chosen as "base".
  • Pull requests to main will be rejected.