When replying to issues and PRs, make sure you always follow our Code of Conduct and our vision for fastlane. Make sure to read these thoroughly and understand them before you interact with any other users! In general, be nice to each other, and treat everyone with the same respect and dignity.
Also, whenever you submit a comment, don’t ask users for their personal information or account credentials.
Issues and PRs may get marked with labels to help the fastlane team communicate with each other and with the community as a whole. Usually most issues and PRs will get two different labels, one for the tool it affects (e.g. fastlane, fastlane_core, supply, ...) and one that represents some general information about the state or nature of the issue/PR.
If you identify an issue that seems interesting but not time-critical, and is simple for new contributors to dive into, we recommend adding the “you can do this” label. PRs labeled “you can do this” should have very clear descriptions of the problem and solution. Remember that someone who is new to fastlane will need some coaching to be successful!
| Label | Meaning |
|---|---|
| action | Applies to a fastlane action (e.g. get_build_number) |
| awaiting-reply | The fastlane team is engaged in discussion, but is currently waiting for a response from the community |
| blocked | We don't currently have a way forward, though we'd like to continue if possible |
| bug | We've acknowledged the issue as a defect |
| duplicate | Another issue/PR already exists that we think captures the problem/request |
| feature | The issue represents a request for an enhancement or new feature |
| you can do this | We're not actively looking at solving this issue, but community help would be appreciated. |
| question | Someone is looking for help, but isn't describing a problem with the software |
Each tool has it’s own label, e.g. fastlane, fastlane_core and gym.
- Clone the fastlane repository by running
git clone [email protected]:fastlane/fastlane.gitin your terminal - For each PR you want to review, make sure to add the user’s fork as a remote
git remote add <GITHUB_USERNAME> [email protected]:<GITHUB_USERNAME>/fastlane.git
- Then, check out the branch for the user’s PR
- Fetch all their branches
git fetch <GITHUB_USERNAME> - Checkout the branch for the PR
git checkout <THEIR_PR_BRANCH> - Sometimes, changes have to be split over multiple PRs - one for each tool. In that case, it is often easier to test all the changes together. To do that, create a new branch that merges all their changes:
- Create a new branch to merge the others into
git checkout -b my_new_branch - Merge the branch from one PR
git pull --rebase <GITHUB_USERNAME> <THEIR_PR_BRANCH> - Repeat the last step for each of the related PRs that the user submitted.
- Create a new branch to merge the others into
- Fetch all their branches
- After checking out a user’s code, you should always make sure that the tests are still working.
- Run
bundle installto make sure all dependencies are installed - Use
bundle exec fastlane testfrom the root directory to run all validation steps (tests, rubocop, etc) - Use
bundle exec rspecfrom the root directory to run all tests - Use
bundle exec rspec [tool_name]to run all tests for a specific tool - Use
bundle exec rubocop -ato run the linter and autocorrect many of the issues it found
- Run
If you have commit access, instead of adding each person's fork as a remote, you can also quickly test a single PR with the following commands:
git fetch origin pull/1234/head:pr-1234
git checkout pr-1234
First of all, since we are testing code that is considered bleeding edge and might not be stable yet, make sure to never test with an account that is provided by your employer and/or real, live apps! Things might break irrevocably! For that reason, we recommend setting up an entirely new account and project for testing fastlane PRs.
Copy the Gemfile .assets/Gemfile from your local fastlane clone and drop it into your project's root folder.
Make sure to replace <PATH_TO_YOUR_LOCAL_FASTLANE_CLONE> with the path to your fastlane clone, e.g. ~/fastlane, then you can run
bundle update
in your project’s directory. After doing so, you can verify you’re using the local version by running
bundle show fastlane
which should print out the path to your local development environment.
Afterwards, execute fastlane or one of the tools using bundle exec <tool>, e.g. bundle exec fastlane or bundle exec deliver.
Before diving into the source code changes of a pull request, step back and think if this change is a good change for fastlane, and that it follows the fastlane vision. If you are not 100% certain that a pull request adds good value to fastlane, ask the author to clarify on why this should be included in the main code base, referring to the Vision.md document. Sometimes it is also more appropriate for new features to be submitted as plugins, for example if the features are not applicable to a wide audience as described here. In that case, make sure to also include a link to the plugin documentation.
To review the code, start a new review on GitHub by going to the “Files changed” tab on the PR page. You can then add comments by tapping on the plus that appears when your mouse hovers over a line. Instead of submitting multiple comments one after another, use the Start Review button, so that participants don’t get flooded with multiple notifications.
When adding comments to a review, make sure they are
- Polite: Ask the author nicely to make the changes. We want to create an environment where our contributors like working with us and come back to submit more PRs
- Constructive: Don’t just say ‘This is bad’ or ‘I don’t like this’. Point the author in the right direction for changes they need to make to improve the code
- Necessary: It is often too easy to ask for changes on perfectly fine code because of personal opinions. If the change follows our vision, adheres to our style guides and is simple to understand, don’t ask the author to change it! You can always make follow-up on a merged PR with improvements of your own.