Skip to content

Latest commit

 

History

History
147 lines (102 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

147 lines (102 loc) · 4.51 KB
Raw

Contribution Guide

We would love for you to contribute to the BlueRecording project and help make it better than it is today. As a contributor, here are the guidelines we would like you to follow:

Got a Question?

Please do not hesitate to raise an issue on github project page.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it.

Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Features can be crafted and directly submitted as a Pull Request.

Submission Guidelines

Issues

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will need as much information as possible, and preferably with an example.

Pull Requests

When you wish to contribute to the code base, please consider the following guidelines:

  • Make a fork of this repository.

  • Make your changes in your fork, in a new git branch:

    git checkout -b my-fix-branch main

  • Create your patch, including appropriate Python test cases. Please check the coding conventions for more information.

  • Run the full test suite, and ensure that all tests pass.

  • Commit your changes using a descriptive commit message.

    git commit -a

  • Push your branch to GitHub:

    git push origin my-fix-branch

  • In GitHub, send a Pull Request to the main branch of the upstream repository of the relevant component.

  • If we suggest changes then:

    • Make the required updates.

    • Re-run the test suites to ensure tests are still passing.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

       git rebase main -i
 git push -f

That’s it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the main branch:

    git checkout main -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your main with the latest upstream version:

    git pull --ff upstream main

Development Environment

For development, we recommend using a combimation of a spack environment and a virtulenvironment

Setup

Start by intalling bluerecoridng in a virtualenv:

python -m venv bluerecording-dev
source bluerecording-dev/bin/activate
pip install -e .

Then create a spack environment, which is used to satisfy the h5py+mpi and mpi4py dependencies

spack env create bluerecording-dev 
spack env activate -p bluerecording-dev 
spack install --add py-h5py+mpi 
spack install --add py-mpi4py

Build

Run the following command to build incrementally the project: pip install -e .

Test

Run the following command to run the Python unit-tests: pytest tests

Coding conventions

The code coverage of the Python unit-tests may not decrease over time. It means that every change must go with their corresponding Python unit-tests to validate the library behavior as well as to demonstrate the API usage.