Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Latest commit

 

History

History
111 lines (75 loc) · 7.5 KB

CONTRIBUTING.md

File metadata and controls

111 lines (75 loc) · 7.5 KB
Raw

Contributing to fastlane

I want to report a problem or ask a question

Before submitting a new GitHub issue, please make sure to

If the above doesn't help, please submit an issue on GitHub and provide information about your setup, in particular the output of the fastlane env command.

Note: If you want to report a regression in fastlane (something that has worked before, but broke with a new release), please mark your issue title as such using [Regression] Your title here. This enables us to quickly detect and fix regressions.

Some people might also use the fastlane tag on StackOverflow, however we don’t actively monitor issues submitted there.

I want to contribute to fastlane

  • To start working on fastlane, check out YourFirstPR.md
  • You will need a Google account to sign the CLA when you make your first PR
  • For some more advanced tooling and debugging tips, check out ToolsAndDebugging.md

Google Contributor License Agreement (CLA)

Upon your first pull request to fastlane, the googlebot will ask you to sign the Google Contributor License Agreement. Once the CLA has been accepted, the PR will be available to merge and you will not be asked to sign it again unless your GitHub username or email address changes.

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

New Actions

Please be aware that we don’t accept submissions for new actions at the moment. You can find more information about that here.

I want to help work on fastlane by reviewing issues and PRs

Thanks! We would really appreciate the help! Feel free to read our document on how to respond to issues and PRs and also check out how to become a core contributor.

Why did my issue/PR get closed?

It's not you, it's us! fastlane and its related tools receive a lot of issues and PRs. In order to effectively work through them and give each the prompt attention it deserves, we need to keep a sharp focus on the work we have outstanding.

One way we do this is by closing issues that we don't feel are immediately actionable. This might mean that we need more information in order to investigate. Or, it might mean that we haven't been able to reproduce it using the provided info. In this case we might close the issue while we wait for others to reproduce the problem and possibly provide some more info that unlocks the mystery.

Another way we do this is by having an automated bot go through our issues and PRs. The main goal of the bot is to ensure that the issues are still relevant and reproducible. Issues can be opened, and later fall idle for a variety of reasons:

  • The user later decided not to use fastlane
  • A workaround was found, making it a low priority for the user
  • The user changed projects and/or companies
  • A new version of fastlane has been released that fixed the problem

No matter the reason, the fastlane bot will ask for confirmation that an issue is still relevant after two months of inactivity. If the ticket becomes active again, it will remain open. If another 10 days pass with no activity, however, the ticket will be automatically closed.

In any case, a closed issue is not necessarily the end of the story! If more info becomes available after an issue is closed, it can be reopened for further consideration.

One of the best ways we can keep fastlane an approachable, stable, and dependable tool is to be deliberate about how we choose to modify it. If we don't adopt your changes or new feature into fastlane, that doesn't mean it was bad work! It may be that the fastlane philosophy about how to accomplish a particular task doesn't align well with your approach. The best way to make sure that your time is well spent in contributing to fastlane is to start your work on a modification or new feature by opening an issue to discuss the problem or shortcoming with the community. The fastlane maintainers will do our best to give early feedback about whether a particular goal and approach is likely to be something we want to adopt!

Code of Conduct

Help us keep fastlane open and inclusive. Please read and follow our Code of Conduct.

Branding

We have a few guidelines for how to refer to fastlane and its tools:

  • fastlane and its actions should be written in all lowercase, even at the beginning of a sentence:
    • ❌ "Use Fastlane to automate your screenshots."
    • ❌ "Use Fastlane to automate your screenshots."
    • ❌ "Fastlane helps you deliver faster."
    • ❌ "Match makes code signing management easy."
    • ✅ "Use fastlane to automate your screenshots."
    • ✅ "fastlane helps you deliver faster."
    • ✅ "match makes code signing management easy."
  • fastlane and all of its actions should be italicized when written in prose:
    • ❌ "fastlane is an all-in-one tool for app automation."
    • ❌ "fastlane is an all-in-one tool for app automation."
    • ❌ "fastlane is an all-in-one tool for app automation."
    • ❌ "fastlane is an all-in-one tool for app automation."
    • ❌ "match makes code signing management easy."
    • ✅ "fastlane is an all-in-one tool for app automation."
    • ✅ "match makes code signing management easy."

Please use these guidelines when writing about fastlane and its tools, be it when contributing to the project or writing about it elsewhere.

Above All, Thanks for Your Contributions

Thank you for reading to the end, and for taking the time to contribute to the project! If you include the 🔑 emoji at the top of the body of your issue or pull request, we'll know that you've given this your full attention and are doing your best to help!

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

This project and all fastlane tools are in no way affiliated with Apple Inc. This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs. All fastlane tools run on your own computer or server, so your credentials or other sensitive information will never leave your own computer. You are responsible for how you use fastlane tools.