Skip to content
This repository has been archived by the owner on Aug 7, 2021. It is now read-only.

Latest commit

 

History

History
94 lines (62 loc) · 6.09 KB

CONTRIBUTING.md

File metadata and controls

94 lines (62 loc) · 6.09 KB
Raw

Contribute to OneBusAway for iPhone

This guide details how to use issues and pull requests (for new code) to improve OneBusAway for iPhone.

Individual Contributor License Agreement (ICLA)

To ensure that the app source code remains fully open-source under a common license, we require that contributors sign an electronic ICLA before contributions can be merged. When you submit a pull request, you'll be prompted by the CLA Assistant to sign the ICLA.

Code of Conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.

Closing policy for issues and pull requests

OneBusAway for iPhone is a popular project and the capacity to deal with issues and pull requests is limited. Out of respect for our volunteers, issues and pull requests not in line with the guidelines listed in this document may be closed without notice.

Please treat our volunteers with courtesy and respect, it will go a long way towards getting your issue resolved.

Issues and pull requests should be in English and contain appropriate language for audiences of all ages.

Issue tracker

The issue tracker is only for obvious bugs, misbehavior, & feature requests in the latest stable or development release of OneBusAway for iPhone. When submitting an issue please conform to the issue submission guidelines listed below. Not all issues will be addressed and your issue is more likely to be addressed if you submit a pull request which partially or fully addresses the issue.

Please send a pull request with a tested solution or a pull request with a failing test instead of opening an issue if you can.

Issue tracker guidelines

Search for similar entries before submitting your own, there's a good chance somebody else had the same issue or feature request. Show your support with :+1: and/or join the discussion. Please submit issues in the following format (as the first post) and feature requests in a similar format:

  1. Summary: Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
  2. Steps to reproduce: How can we reproduce the issue
  3. Expected behavior: Describe your issue in detail
  4. Observed behavior
  5. Screenshots: Can be created by pressing the home and power button at the same time
  6. Possible fixes: If you can, link to the line of code that might be responsible for the problem

Pull requests

We welcome pull requests with fixes and improvements to OneBusAway for iPhone code, tests, and/or documentation. The features we would really like a pull request for are listed in the ROADMAP but other improvements are also welcome.

Pull request guidelines

If you can, please submit a pull request with the fix or improvements including tests. If you don't know how to fix the issue but can write a test that exposes the issue we will accept that as well. In general bug fixes that include a regression test are merged quickly while new features without proper tests are least likely to receive timely feedback. The workflow to make a pull request is as follows:

  1. Fork the project on GitHub
  2. Create a feature branch
  3. Write tests and code
  4. Ensure your changes follow the The New York Times style guide
  5. Summarize the changes you are making in a ~1 line high-level summary (see below for preferred format)
  6. If you have multiple commits please combine them into one commit by squashing them
  7. Push the commit to your fork
  8. Submit a pull request against the develop branch with a motive for your change and the method you used to achieve it
  9. Search for issues related to your pull request and mention them in the pull request description or comments

We will accept pull requests if:

  • The code has proper tests and all tests pass (or it is a test exposing a failure in existing code)
  • It can be merged without problems (if not, please use: git rebase upstream/develop)
  • It doesn't break any existing functionality
  • It's quality code that conforms to The New York Times style guide and standard best practices
  • The description includes a motive for your change and the method you used to achieve it
  • It is not a catch all pull request but rather fixes a specific issue or implements a specific feature
  • It keeps the OneBusAway for iPhone code base clean and well structured
  • We think other users will benefit from the same functionality
  • If it makes changes to the UI the pull request should include screenshots
  • It is a single commit (please use git rebase -i to squash commits)

Note: If another pull request is merged into the develop branch that causes your pull request to no longer merge cleanly, you may be asked to rebase (git rebase upstream/develop).

Workflow

Feature branches -> develop branch -> master branch

  • Feature branches: Branch for each bug fix, new feature, etc.
  • develop branch: Next version in the making, latest development code; should be semi-stable.
  • master branch: Reflects latest App Store release code, should be stable and bug free.

License

By contributing code to this project via pull requests, patches, or any other process, you are agreeing to license your contributions under the Apache License, Version 2.0.

Preferred Commit Message Format

Pithy and short title for my changes

Fixes https://github.com/OneBusAway/onebusaway-iphone/issues/ISSUE_NUMBER - Title of the issue you fixed

Here are a couple sentences that explain what I did.

* Here is a bullet point that further explains this commit, if necessary
* And another bullet point, if necessary
* etc