Skip to content
This repository was archived by the owner on Apr 15, 2022. It is now read-only.

Latest commit

 

History

History
64 lines (47 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 3.37 KB

Contributing

Thank You!

Thank you for considering to allocate some of your precious time to moving this project forward. Awesome to see you here! You don't have to be an expert to help us, every small tweak, crazy idea and/or bugreport is highly appreciated! In return you will receive valuable feedback and be listed as a contributor inside the app as it appears on the iOS App Store.

Contribution Requirements

  • You have forked this repository and cloned it to your local machine
  • You have the latest version of Xcode installed (currently 12.3)
  • You have completed the steps to get started and can build the project as detailed in the README.md
  • You have set the following Indentation settings for Xcode:

Screenshot 2020-06-24 at 00 15 45

❗️ Commiting changes caused by improper re-indentation will be rejected automatically.
❗️ They will have to be fixed before your pull request can be reviewed.

Contribution Guidelines

Before You Begin Coding

  1. Select an issue-ticket that is labeled Contributable from the next release project as detailed in the README.md
❗️ There are many reasons for issue-tickets not being labeled with `Contributable`. 
❗️ The most important may be that they require other tickets to be completed first 
❗️ (in a specific way). Therefore you may do unnecessary work which might not be 
❗️ usable when tackeling them anyway.
  1. Comment that you want to start working on the issue
  2. Wait for feedback to receive clearance for beginning the coding process
    • You may be asked to join the official discord to receive further instructions
    • For some tickets you will be asked to deliver a design document that needs to be cleared before you can begin your work
  3. If you need help or guidance there will be a channel dedicated to your issue-ticket on the official discord
❗️ If you submit code without following these steps you may or may not receive a review.
❗️ However in the case of receiving a review it may be subject to an adverse amount of 
❗️ change requests.

Writing and Delivering Your Code

  1. Before you start please make sure you meet the contribution requirements
  2. Checkout the develop-branch from your local clone and create a new branch from there (the name to use will be outlined in the issue-ticket)
  3. Open a pull request as soon as you commit your first changes
  4. Set the pull request to draft while you are working on it
  5. Make sure your code runs locally before you request a review
  6. Make sure to not commit any changes relating to CocoaPods within the project file (you can run pod deintegrate before your final commit)
  7. Make sure you do not introduce any new SwiftLint warnings into your code
  8. Once your are ready to have your code looked at, set it to ready for review
❗️ Do not include any changes that are not related to your assigned issue ticket.
❗️ Your pull request will not be reviewed until this requirement is met.

Contribution Terms

Your code submission is subject to the MIT License and can be used, reused, amended or changed at the project author's or other contributors' discretion.