From f0f100a0983596c8499bc3d545e320c12dc3734d Mon Sep 17 00:00:00 2001 From: iliyangermanov Date: Wed, 30 Aug 2023 22:47:56 +0300 Subject: [PATCH] Update CONTRIBUTING.md and the PR template --- .github/PULL_REQUEST_TEMPLATE.md | 37 ++++++------------------------- CONTRIBUTING.md | 38 ++++++++++++++++---------------- 2 files changed, 26 insertions(+), 49 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8df68562af..bebc91819b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,14 +1,10 @@ ## Pull Request (PR) Checklist Please check if your pull request fulfills the following requirements: -- [ ] The PR is submitted to the `develop` branch. -- [ ] I understand the **[Ivy Developer Guidelines](../docs/Developer-Guidelines.md)**. -- [ ] I've read the **[Contribution Guidelines](https://github.com/ILIYANGERMANOV/ivy-wallet/blob/main/CONTRIBUTING.md)**. +- [ ] The PR is submitted to the `main` branch. +- [ ] I've read the * + *[Contribution Guidelines](https://github.com/Ivy-Apps/ivy-wallet/blob/main/CONTRIBUTING.md)**. - [ ] The code builds and is tested on an actual Android device. - [ ] I confirm that I've run the code locally and everything works as expected. -- [ ] I confirm that I've run Ivy Wallet's UI tests (`androidTest`) and all tests are passing - successfully. - -_Important: Don't worry if you experience flaky UI tests. Just re-run the failed ones again and if they pass => it's all good!_ _Put an `x` in the boxes that apply._ - [x] Demo: Checking checkbox using `[x]` @@ -28,11 +24,12 @@ Please check the type of change your PR introduces: - [ ] Tests (Unit, Integration, UI tests) - [ ] Other (please describe): -_Put an `x` in the boxes that apply._ +_Put an `x` in all the boxes that apply._ ## Does this PR closes any GitHub Issues? -Check **[Ivy Wallet Issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues)**. + +Check **[Ivy Wallet Issues](https://github.com/Ivy-Apps/ivy-wallet/issues)**. - Closes #N/A (type issue number here) @@ -43,24 +40,4 @@ Describe with a few bullets **what's new:** - c - d -## How to run Ivy Wallet's UI tests (`androidTest`) -**Connect Android Emulator** -- Pixel 5 API 29+ AVD emulator _(recommended)_ -- Pixel 3XL API 29+ AVD emulator _(recommended)_ -- Large screen physical device _(might also work)_ - -**Method 1: Android Studio UI** -- Find `com (androidTest)` package -- Right click -- `Run 'Tests in 'com''` - -_Note: If you've checked "Compact Middle Packages" the option will appear as `com.ivy.wallet (androidTest)`._ - -**Method 2: Gradle Wrapper** -- `chmod +x gradlew` (Linux) -- `./gradlew connectedDebugAndroidTest` - -**Method 3: Fastlane** -- Install Ruby 2.7 -- `bundle install` -- `bundle exec fastlane ui_tests` +_💡Tip: Attach screenshots and screen recordings. It helps a lot!_ \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e19d0c79df..22393ebaa3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,10 @@ # Contributing to Ivy Wallet -## [Ivy Developer Guidelines](docs/Developer-Guidelines.md) - -A short and helpful guide on Android Architecture, Functional Reactive Programming (FRP) and Ivy best practices - [Ivy Developer Guidelines](docs/Developer-Guidelines.md). - -> Tip: Read it -> make proposals -> make the project better! :rocket: - ## 1. Fork the repo **[How To Fork Guide by GitHub](https://docs.github.com/en/get-started/quickstart/fork-a-repo)** -`gh repo fork https://github.com/ILIYANGERMANOV/ivy-wallet` +`gh repo fork https://github.com/Ivy-Apps/ivy-wallet` ## 2. Pick an issue @@ -18,23 +12,25 @@ What do you want to work on? How do you want to contribute? ### Workflow: -1. Browse **[Ivy Wallet Issues](https://github.com/ILIYANGERMANOV/ivy-wallet/issues)**. +1. Browse **[Ivy Wallet Issues](https://github.com/Ivy-Apps/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](https://github.com/ILIYANGERMANOV/ivy-wallet/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) + label [good first issue](https://github.com/Ivy-Apps/ivy-wallet/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) are easier. -- You can also help us clean up the [issue section](https://github.com/ILIYANGERMANOV/ivy-wallet/issues) by identifying duplicate issues. +- You can also help us clean up the [issue section](https://github.com/Ivy-Apps/ivy-wallet/issues) + 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 +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: @@ -46,23 +42,27 @@ repository. - Make commits. - Refactor your code. - Verify that your implementation works. +- Test that you haven't broken existing features. ### 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 +## 4. Submit a PR to `main` 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 `main` branch of the +official [Ivy Wallet repo.](https://github.com/Ivy-Apps/ivy-wallet/pulls) -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.](https://github.com/ILIYANGERMANOV/ivy-wallet/pulls) +* -**[How To Submit a PR Guide by GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)** +*[How To Submit a PR Guide by GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) +** ### IMPORTANT: -- Make sure that on the base repository's base the `develop` branch is chosen as "base". -- Pull requests to `main` will be rejected. +- Make sure that on the base repository's base the `main` branch is chosen as "base". +- Pull requests to other branches will be rejected.