Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 3.38 KB
Raw

Introduction

Welcome and thank you for considering contributing to the FINBOURNE Sample Jupyter Notebooks repository. We're delighted to have you as part of our community.

Following these guidelines will help us to manage the contribution process effectively for everyone involved. It communicates that you respect the time of our Core Team managing and developing this open source project. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.

Getting in touch

If you find a security vulnerability, please do NOT open a GitHub issue. Any security issues should be submitted directly to [email protected].

Please don't use the GitHub issue tracker for support questions. For help on using LUSID or Luminesce, please contact [email protected].

Contributing

We welcome contributions from our community.

There are many ways to contribute, from creating Jupyter Notebooks for new use cases, to fixing bugs or improving the efficiency of existing code. This section guides you through submitting a contribution to this repo.

Code of conduct

FINBOURNE has adopted the Contributor Covenant as its code of conduct, and we expect contributors to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.

Style guide

We have a set of conventions we'd like you to adhere to when creating or changing a Jupyter Notebook; please take a look at our style guide.

License

By contributing to this FINBOURNE repo, you agree that your contributions will be licensed under its MIT license.


Submitting changes

If you have a change that you would like to contribute, please find or open an issue about it first. You might find that somebody is already working on the issue, or there may be particular issues that you should know about before implementing the change.

To submit your change:

  1. Fork our repository to your own GitHub account (this GitHub guide describes how to do this).
  2. Clone the project to your local machine.
  3. Create a new branch and clearly title it with the change.
  4. Make your changes and ensure the Jupyter Notebook runs in its entirety with no issues.
  5. Push your changes to your fork. We prefer for your changes to be squashed into a single commit.
  6. Submit a pull request to the develop branch of our repository.
  7. The Core Team will add a “/LGTM” comment to trigger the build (note this does not approve the pull request). We will then review your code and leave any comments for you to address before we merge your change into the master branch.

Code review process

The Core Team reviews pull requests on a regular basis and will give feedback on the corresponding issue in the repo. Please note:

  • A build will run as part of your pull request; at a minimum, this needs to pass before your contribution is accepted.
  • After feedback has been given, it is expected that you respond within two weeks. The pull request may be closed if it does not show any signs of activity.