Skip to content

Latest commit

 

History

History
95 lines (56 loc) · 2.88 KB

contributing.rst

File metadata and controls

95 lines (56 loc) · 2.88 KB
Raw

Contributing

PyKE is actively developed on its GitHub repository.

If you encounter a problem with PyKE, we encourage you to open an issue on the GitHub repository or to e-mail the Kepler/K2 Guest Observer Office at keplergo@mail.arc.nasa.gov.

If you would like to contribute a patch for a bugfix, please go ahead and open a pull request.

Proposing changes to PyKE using GitHub pull requests

We welcome suggestions for enhancements or new features to PyKE 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:

1. Fork the main PyKE repository by logging into GitHub, browsing to https://github.com/KeplerGO/PyKE and clicking on Fork in the top right corner. 2. Clone your fork to your computer:

$ git clone https://github.com/YOUR-GITHUB-USERNAME/PyKE.git
  1. Install the development version of PyKE:
$ cd PyKE
$ pip install -e .
  1. Add the KeplerGO remote to your GitHub enviroment:
$ git remote add upstream https://github.com/KeplerGO/PyKE.git
  1. 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/PyKE.git (fetch)
origin  https://github.com/YOUR-GITHUB-USERNAME/PyKE.git (push)
upstream    https://github.com/KeplerGO/PyKE.git (fetch)
upstream    https://github.com/KeplerGO/PyKE.git (push)
  1. 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
  1. Do the changes you want and add them:
$ git add FILE-YOU-ADDED-OR-MODIFIED
  1. Commit and push your changes:
$ git commit -m "description of changes"
$ git push origin name-of-my-branch

9. Head to https://github.com/KeplerGO/PyKE and you should now see a button "Compare and open a pull request". Click the button and submit your pull request. 10. That's it! :)

Coding and documentation guidelines

PyKE adopts AstroPy's coding guidelines and standards, as documented in AstroPy's Development Documentation.