Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 2.9 KB
Raw

Contributing to open-event-ios

So... you've decided to contribute to this repository...

Welcome! Thank you so much for the interest. Below here are some guidelines we've put together to help you get started quickly

Getting Started

  • Download the file of finalized designs here
  • If there's a bug/issue you've found, create the issue
  • Fork and clone the repository
  • Create a branch with the work you're going to do
  • When finished with changes, create a PR against the development branch of this repository

What to Work On

Check the list of issues

Contribution Guidelines

Any PRs are welcome

Spot a typo? Send a pull request! Use of mutable values at the wrong places? Send a pull request!

Basically, if you have something to contribute, we'll be more than happy to merge it if it fits the goals for the app.

Making Changes

This is important. So read this part carefully.

If you're writing something that introduces a new design or requires the modification of the existing user interface, please create an issue with the design tag and discuss your proposed changes before writing any code. Even if design is not your forte, raising that issue can give someone else the opportunity to contribute a design. This is to help maintain and regulate a high standard of user experience in the app.

Note: the .sketch file will soon be made available once the app has been finalised and released on the App Store

Bug Reports

Guidelines for bug reports:

  1. Check Github Issues - see if bug has already been reported
  2. Check if issue is fixed - attempt to reproduce with latest master
  3. Identify if your issue relates to one of the following: Design/Frontend or Bug
  4. Use the bug report template below and create a new issue

Example:

Short and descriptive example bug report summary (title)

### Environment

The OS environment in which the issue occurs. (Version of iOS, device type etc)

### Steps to Reproduce
If suitable, include the steps required to reproduce the bug.

1. This is the first step
2. This is the second step
3. Further steps, etc.

Any other information you want to share that is relevant to the issue being reported. Especially, why do you consider this to be a bug? What do you expect to happen instead?

### Technical details:

* Version: beta 0.1.0-1234

Feature Requests

Before you submit be sure to do the following:

  1. Search existing issues for similar requests and comment on that one instead of creating a new issue
  2. Take a moment and think if the feature fits the scope of the application and such feature will positively benefit a user's conference-going experience
  3. Provide as much detail and context and possible with a few use cases that will help make your feature request more convincing