Contributing and reporting issues¶
lightkurve is actively developed on its GitHub repository.
If you would like to contribute a patch for a bugfix, please go ahead and open a pull request.
Proposing changes to lightkurve using GitHub pull requests¶
We welcome suggestions for enhancements or new features to lightkurve via GitHub.
If you want to make a significant change such as adding a new feature, we recommend opening a GitHub issue to discuss the changes. Once you are ready to propose the changes, please go ahead and open a pull request.
If in doubt on how to open a pull request, we recommend Astropy’s “How to make a code contribution” tutorial. In brief, the steps are as follows:
- Fork the main lightkurve repository by logging into GitHub, browsing to
https://github.com/KeplerGO/lightkurveand clicking on
Forkin the top right corner.
- Clone your fork to your computer:
$ git clone https://github.com/YOUR-GITHUB-USERNAME/lightkurve.git
- Install the development version of lightkurve:
$ cd lightkurve $ pip install -e .
- Add the KeplerGO remote to your GitHub enviroment:
$ git remote add upstream https://github.com/KeplerGO/lightkurve.git
- Let’s make sure everything is setup correctly. Execute:
$ git remote -v
You should see something like this:
origin https://github.com/YOUR-GITHUB-USERNAME/lightkurve.git (fetch) origin https://github.com/YOUR-GITHUB-USERNAME/lightkurve.git (push) upstream https://github.com/KeplerGO/lightkurve.git (fetch) upstream https://github.com/KeplerGO/lightkurve.git (push)
- Now you are ready to start contributing; make a new branch with a name of your choice and checkout:
$ git branch name-of-your-branch $ git checkout name-of-your-branch
- Do the changes you want and add them:
$ git add FILE-YOU-ADDED-OR-MODIFIED
- Commit and push your changes:
$ git commit -m "description of changes" $ git push origin name-of-my-branch
- Head to https://github.com/KeplerGO/lightkurve and you should now see a button “Compare and open a pull request”. Click the button and submit your pull request.
- That’s it! :)