Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 3.79 KB
Raw

Contributing to F2

F2 is currently maintained by Markit On Demand and you're encouraged to contribute to this project right here on GitHub. The following are guidelines for contributing; please familiarize yourself before sending pull requests.

Thank you to the growing list of contributors!

Getting Started

First, a couple of ground rules.

  1. Make sure you have a GitHub account.
  2. Submit a ticket for your issue, assuming one does not already exist. (Search first!)
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Include the F2 version number.
  3. Fork the F2 repository.

Making Changes

Understanding the "wip" branch

The latest F2 changes can be found in the -wip branch. This branch's name uses the upcoming version number followed by -wip which stands for "work-in-progress", for example 1.3.1-wip as shown below. There will only be one -wip branch at any given time.

Do not work directly in master!

Branches

Steps

Once you've forked the F2 repository:

  1. Create a new branch in your fork from the next.version-wip branch. Do not work directly in master!
    • $> git checkout -b 'your_branch_name' next.version-wip
  2. Read the F2 coding standards.
  3. Add and document unit test(s) for your changes. At least one unit test is required.
  4. Re-run all the Jasmine tests to confirm your changes didn't break anything. $> grunt test
  5. Perform browser testing in supported browsers.
  6. Add a detailed commit message.

Committing Changes

  • You should only commit files you have changed. Do not commit compiled or generated F2 files, except:
    • If you've modified any file in the /sdk/src/ directory, you must commit /sdk/f2.min.js for the Travis unit tests.
  • Push committed changes to your branch.
  • Submit a pull request for F2\next.version-wip not F2\master.
  • Add a message or additional detail for your changes in the pull request.
  • Wait for your change(s) to be reviewed.

Coding Standards

Coding standards promote a common vocabulary and syntax so that our fellow developers can concentrate on what you're saying rather than on how you're saying it. It is ultimately up to you how you write your own code, but please become familiar with the standards and use them when contributing to F2.

Coding standards help an individual project, and also make it easier for one project to reuse components from another project. This, of course, is a core component of F2.

Read our coding standards on the wiki.

Keep in Touch

If you have any questions while writing code to contribute to F2, post a message on the Google Group, find us on Twitter @OpenF2 or by email at info@openf2.org. You can also follow our blog for more in-depth F2 updates.

Resources