Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

46 lines (31 loc) · 2.28 KB
Raw

Introduction

Thank you for your interest in contributing to HadoukenIO Notifications Service. Default behaviors of a project like Notifications Service greatly benefit from the opinions and contributions of the community.

Following these guidelines will expedite any changes you propose by providing clarity around both the goals of the service and the development process.

Contributions

Ground Rules

  • This project uses Google TypeScript Style. Successfully run npm run fix before making a pull request (this will run gts).
  • If your change would update either this guide or the README, include relevant changes in your PR.

Getting started

To build the project locally, follow the steps in the README here.

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Sign the FINOS Contributors License Agreement available here
    • If you are working on behalf of an organization, your employer must sign the CLA.
    • Send a pull request indicating that you have a CLA on file.

How to report a bug

When filing an issue, make sure to answer these five questions:

  1. What operating system and processor architecture are you using?
  2. What version of node are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

Add your issue to the repository issues.

Roadmap

The project README includes the current roadmap

Issues

The project README inlcudes a list of known issues. Other issues can found in the issues tab.

How to suggest a feature or enhancement

Before suggesting an improvement, please see the README for current roadmap items and known issues.

The goal of this project is to provide robust notification management as an out of the box solution for applications running on OpenFin. Feature requests are welcome and should include rational.