Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 3.05 KB

How to Contribute to F2

F2 is an open and free web integration framework designed to help you and other financial industry participants develop custom solutions that combine the best tools and content from multiple providers into one, privately-labeled, seamlessly integrated front-end.

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.

Getting Started

A couple of ground rules.

  • Make sure you have a GitHub account.
  • 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.
    • Be sure to include the F2 version number.
  • Fork the F2 repository on GitHub.

Making Changes

  • Create a branch from where you want to base your changes.
  • Do not work directly in master; create a branch based on master using git checkout -b 'your_branch_name' master.
  • Follow our coding standards.
  • Preferably add and document unit test(s) for your changes.
  • Re-run all the Jasmine tests to confirm your changes didn't break anything.
  • Perform browser testing in our supported browsers.
  • Add a detailed commit message.

Submitting Changes

  • Push committed changes to your branch.
  • Submit a pull request in the F2 project repository.
  • Add a message or additional detail for your changes in the pull request.
  • Wait for your change 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 back 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 back to F2, contact us on our Google Group, find us on Twitter @OpenF2 or by email at [email protected]. You can also follow our blog for more in-depth F2 updates.

Resources