Skip to content

Latest commit

 

History

History
86 lines (71 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

86 lines (71 loc) · 3.34 KB
Raw

Contributing to the BluePyEfe

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

Got a Question or Problem?

Please do not hesitate to contact us on Gitter.

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.

Submission Guidelines

Submitting an Issue

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 be in touch with you to gather information.

Submitting a Pull Request (PR)

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 master
  • Create your patch, ideally including appropriate test cases.
  • Run the full test suite, and ensure that all tests pass.
  • Commit your changes using a descriptive commit message. 
    git commit -a
    Note: the optional commit -a command line option will automatically “add” and “rm” edited files.
  • Push your branch to GitHub: 
    git push origin my-fix-branch
  • In GitHub, send a Pull Request to the master 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 master -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 master branch: 
    git checkout master -f
  • Delete the local branch: 
    git branch -D my-fix-branch
  • Update your master with the latest upstream version: 
    git pull --ff upstream master