Implement Jazzband guidelines for project python-geojson

[jazzband-bot]

This issue tracks the implementation of the Jazzband guidelines for the project python-geojson

It was initiated by @frewsxcv who was automatically assigned in addition to the Jazzband roadies.

See the TODO list below for the generally required tasks, but feel free to update it in case the project requires it.

Feel free to ping a Jazzband roadie if you have any question.

TODOs

• Fix all links in the docs (and README file etc) from old to new repo
• Add the Jazzband badge to the README file
• Add the Jazzband contributing guideline to the CONTRIBUTING.md file
• Check if continuous testing works (e.g. Travis-CI, CircleCI, AppVeyor, etc)
• Check if test coverage services work (e.g. Coveralls, Codecov, etc)
• Add jazzband account to PyPI project as maintainer role (e.g. URL: https://pypi.org/manage/project/<PROJECTNAME>/collaboration/)
• Add jazzband-bot as maintainer to the Read the Docs project (URL: https://readthedocs.org/dashboard/<PROJECTNAME>/users/)
• Fix project URL in GitHub project description
• Review project if other services are used and port them to Jazzband
• Decide who is project lead for the project (if at all) and setup CI for it if needed

Project details

Description	Python bindings and utilities for GeoJSON
Homepage	https://pypi.python.org/pypi/geojson/
Stargazers	392
Open issues	16
Forks	62
Default branch	master
Is a fork	False
Has Wiki	True
Has Pages	False

[rayrrr]

I'm going to open a separate issue as per policy but since this one is already here, I volunteer to be Project Lead on this project.

[rayrrr]

Coverage and Travis are both confirmed working on the master branch after merging jazzband/geojson#120 so I checked those off.

[jezdez]

@rayrrr Would you mind working on the rest of the TODOs above to finalize the transfer to Jazzband, please?

[rayrrr]

@jezdez Yes, I am happy to do so. Thanks for the reminder!

[rayrrr]

@jezdez I've just added the Jazzband badge to the README, as well as a CONTRIBUTING.rst file. I don't have access to the "Settings" tab on the project, so if any additional config is required to display the contributing guidelines as recommended by Jazzband, I'll need your help there.

As for Read the Docs, @frewsxcv we are going to need your help because because RtD still points to your personal GitHub account and lists you as the maintainer from before you switched the repo over to Jazzband. Can you point it to the Jazzband URL and make jazzband-bot the maintainer when you have a moment? https://readthedocs.org/projects/geojson

Thanks in advance.

[frewsxcv]

Can you point it to the Jazzband URL and make jazzband-bot the maintainer when you have a moment? https://readthedocs.org/projects/geojson

Done and done!

[jezdez]

FWIW it seems as if there is just no Sphinx documentation so far, so moving the README to a docs/index.rst would make sense (and before starting a new project with sphinx-quickstart docs/).

[rayrrr]

@jezdez I would like to implement this in a way that maintains the display of the README on the GitHub repo page and doesn't create repeated documentation in two places. Would it be possible/acceptable to use a reST include directive along the lines of jazzband/geojson#134 for Sphinx/RtD?

[rayrrr]

@jezdez an unsolicited user took the liberty of merging the PR (do you know them? it's not the first time they did so). Anyway, the reST include directive appears to have worked: https://geojson.readthedocs.io so can we go ahead and close this out now?

[jezdez]

@jezdez I would like to implement this in a way that maintains the display of the README on the GitHub repo page and doesn't create repeated documentation in two places. Would it be possible/acceptable to use a reST include directive along the lines of jazzband/geojson#134 for Sphinx/RtD?

Hey, apologies for the slow reply, this sounds definitely like a good idea, I've seen this setup in a few projects over the years, e.g. https://daler.github.io/sphinxdoc-test/includeme.html#index-rst-changes documents this even. So go for it.

@jezdez an unsolicited user took the liberty of merging the PR (do you know them? it's not the first time they did so). Anyway, the reST include directive appears to have worked: https://geojson.readthedocs.io so can we go ahead and close this out now?

Yeah, @auvipy tends to go through PRs in many projects (not only Jazzband's) and contributes by merging them when they see no obvious blockers. Sadly this type of contribution pattern also has a high risk of missing context, so it's definitely sensible to talk to each other like you did and raise this with me if it happens again. I apologize if this has made your work harder, this is of course not the Jazzband's intention. Rest assured, receiving contributions from other Jazzband members (~500 at this moment) can be a little bit intimidating at first, so I appreciate your reaching out and working through this with me.

@auvipy Please be so kind and take greater care with reviewing PRs and submit a PR review with an approval than merging them right away. Especially for those projects that you have not had a track record in, or which are new to Jazzband this allows growing together as a team more organically. Also, project sites on jazzband.co do list the project leads (e.g. https://jazzband.co/projects/geojson) so please make sure to look at that information when you start contributing to new projects.

[auvipy]

thanks, I will follow the guides and more careful.

[jezdez]

@auvipy Thank you!

[rayrrr]

https://geojson.readthedocs.io is looking good. Closing this out. Thanks @jezdez and @frewsxcv for your late-game assists!