search

hipspy / hips

Python library to handle HiPS
https://hips.readthedocs.io
13 stars 16 forks source link

Sphinx update #12

Closed adl1995 closed 7 years ago

adl1995 commented 7 years ago

Added link to my GSoC application, blog, and updated the note directive.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling dfb5d0e876e87e551756e177c1427a5959a3e1da on adl1995:sphinx-update into e223093605b1de014bf2457040e44d54bce2e81a on hipspy:master.

cdeil commented 7 years ago

@adl1995 - Thanks for splitting this docs note update out into a separate pull request.

When you make a pull request, please always review the diff and commmits (yourself, before opening the PR and Thomas or I start reviewing it).

In this case, looking at https://github.com/hipspy/hips/pull/12/files, I still see hips/tiles/tilefilecache.py from #11 which shouldn't be here. Also, there's 10 commits in https://github.com/hipspy/hips/pull/12/commits for something that should be a single-commit, single-addition in one file (so that we get a sensible / clean git history for this repo).

Probably the root of these git issues is that you started #12 in adl1995:master, i.e. started to do work and commits in your local master branch. You should never do that, but always start the work by making a new feature branch. See e.g. http://astropy.readthedocs.io/en/latest/development/workflow/development_workflow.html#workflow

Please take a few hours to read through some git / github info (e.g. a tutorial or Github docs, or the Astropy dev guide) and let me know if you have any question.

Now how to clean up? One simple option could be to close #11 and this pull request, and to start fresh with new branches / pull requests. Of course, with git, it's also possible to clean up / recover with your existing branches / pull requests. But that requires some more knowledge of git like for example using git rebase or git reset. If you want, you could try and practice git for this sphinx-update branch, and get rid of hips/tiles/tilefilecache.py and squash all the commits into a single one with the edit in docs/index.rst.