Skip to content

Latest commit

 

History

History
27 lines (15 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

27 lines (15 loc) · 2.09 KB

Contributing

Anybody working for the Financial Times is welcome to suggest changes via a GitHub issue or pull request. This short guide is for people who'd like to contribute, and covers some general guidelines.

  1. As with all digital communication between Financial Times employees, contributions to this repo are covered by the Financial Times code of conduct. Be respectful to your colleagues.

  2. Issues and Pull Requests are a better place to have discussions than Slack or in-person – they act as documentation for future contributors.

  3. Before opening an issue or Pull Request, do a quick search to see if it's been discussed before. If you want to raise several points, open a separate issue for each of them — this will help keep the discussion focused.

How to Contribute

There are many different ways you can contribute and help make this resource better for everyone:

  • Contribute to the Engineering Competencies
    The Engineering competencies are used to inform conversations about career progression between an engineer and their line manager. Every engineer in the CTO organisation of the Financial Times can help shape these competencies. A guide for adding or editing competencies is here.

  • Contribute to the documentation and website
    It's important that the documentation in this repo and the Engineering Progression website are clear and easy to understand. Get started maintaining the documentation

  • Build your own integration
    The competencies data is available through a JSON API, which means that engineers at the Financial Times can build their own integrations on top of it. Get started writing your own integrations

  • Contribute to the running of this repository
    This repository is the one source of truth for engineering careers and progression, and as such it's important that the code is maintained. It's also important that issues and pull requests are responded to quickly. Get started contributing to the running of this repo