Contributing to the Daily Dozen App for iOS

We would love for you to contribute to our source code and to help make the Daily Dozen for iOS even better! Here are the guidelines we would like you to follow:

Have a Question or Problem?

If you have a question or issue with how to use the Daily Dozen for iOS app or other support-related questions, please contact us by visiting the NutritionFacts.org Help Desk on Zendesk.

Found an Issue?

If you find a bug in the source code, a mistake in the documentation, or a translation error, you can help by submitting it in the issues. Even better, you can submit a Pull Request with a fix for the issue.

Please Note: This repository is only for issues within the Daily Dozen iOS source code. Issues in other app components or the Daily Dozen Android version should be reported in their respective repositories.

Please see our Submission Guidelines below for more information

Want a Feature?

You can request a new feature by submitting an issue.

  • Major Changes that you wish to contribute to the project should be discussed first so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project. This is especially useful when dealing with large UI changes within the application that may require the approval of mock-ups and screen workflows to stay consistent within our brand.

  • Small Changes can be crafted and submitted to the GitHub Repository as a Pull Request.

Submission Guidelines

Submitting an Issue

Before you submit your issue, please search the archive. Your issue may have already been addressed.

If your issue appears to be a bug, and it hasn't been reported, open a new issue. Please help us to maximize the effort we can spend fixing issues and adding new features by not reporting duplicate issues.

When submitting an issue, providing the following information will increase the chances of your request being dealt with quickly:

  • Overview of the Issue - if an error is being thrown, a stack trace or log helps (if available)
  • Motivation for or Use Case - explain why this is a bug for you and what was expected
  • iOS Version(s) - current iOS version
  • Device Model - is it a problem with all devices or only a specific model?
  • Stock or Customized System - provide details on system customization, if customized
  • Daily Dozen App Version: - current app version
  • Steps to Reproduce the Issue - provide an unambiguous set of steps with screenshots (if possible)
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Working on Your First Pull Request?

We want to foster a community of participation and learning, especially for people interested in committing to FOSS projects. Kent C. Dodds provides a great set of tutorials covering How to Contribute to an Open Source Project on GitHub geared toward submitting your first Pull Request. Check it out and start contributing!

Submitting a Pull Request

Before you submit your Pull Request consider the following guidelines:

Search for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

Please submit all pull requests to the nutritionfactsorg/daily-dozen-ios repository in the develop branch.

As you're working on bug fixes or features, please break them out into their own feature branches and open the Pull Request against your feature branch. It makes it much easier to decipher down the road, as you open multiple Pull Requests over time, and makes it much easier for to approve pull requests quickly.

If you don't have a feature in mind, but would like to contribute back to the project, check out the open issues and see if there are any you can tackle.

If you have a feature in mind that hasn't been asked for in Github Issues, please open an issue so that we can discuss how it should work so that it will benefit the entire community.

 

Have more questions? Submit a request
Powered by Zendesk