New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Completing the Developer Guide #144

Merged
merged 6 commits into from Nov 23, 2014

Conversation

Projects
None yet
3 participants
@leouieda
Member

leouieda commented Nov 20, 2014

Writing some more sections for the Developer Guide.

  • Getting started: sign up for Github, make a fork, etc
  • Setting up: install things, setup environment variables
  • Building: compiling C extensions and Cython
  • Testing: unit and doctests
  • Code style: PEP8 and the auto checker
  • Documentation: building and serving the docs

I tried to include some links to reference material for those new to software development. Most are links to Software Carpentry.

There is a version of the docs of this PR on ReadTheDocs: http://fatiando.readthedocs.org/en/devel-guide/develop.html

It will be updated automatically with the PR.

Fixes #25 (probably all of it)

Checklist:

  • Code and docs have been spellchecked
  • Changelog entry
  • Include new dependencies in docs, requirements.txt, README
  • Documentation builds properly
  • All tests pass
  • Can be merged
More sections on devel guide
Getting started: sign up for Github, make a fork, etc
Setting up: install things, env variables
Building: compiling C ext and Cython
Testing: unit and doctests
Code style: PEP8 and the auto checker
Documentation: Building and serving the docs

All have links to reference material (most are software carpentry)

@leouieda leouieda added the docs label Nov 20, 2014

@coveralls

This comment has been minimized.

coveralls commented Nov 20, 2014

Coverage Status

Coverage remained the same when pulling fa3bdf8 on devel-guide into 246b4d7 on master.

@hbueno

This comment has been minimized.

Member

hbueno commented Nov 21, 2014

Hi @leouieda, I found your text very clear and concise.

@hbueno

This comment has been minimized.

Member

hbueno commented on fa3bdf8 Nov 21, 2014

Hi @leouieda, I found your text very clear and concise. I've one suggestion but far away to be relevant. Maybe put a link in "scope of the project" which points to a brief description already done (e.g, this overview https://github.com/fatiando/fatiando/blob/devel-guide/doc/index.rst) or another one more detailed (?).

@hbueno

This comment has been minimized.

Member

hbueno commented on doc/develop.rst in fa3bdf8 Nov 21, 2014

To me this link didn't work.

This comment has been minimized.

Member

leouieda replied Nov 21, 2014

Thanks for pointing this out! Turns out you need to have admin rights to the organization for that. I'll replace it with something else.

@hbueno

This comment has been minimized.

Member

hbueno commented on doc/develop.rst in fa3bdf8 Nov 21, 2014

@leouieda it's more a question then a suggestion, and I'm not sure if here is the right place to ask but... Fatiando intends to use only C-extensions that were automatically generated using Cython (from the .pyx files), or we can try to make use of some pure .c?

This comment has been minimized.

Member

leouieda replied Nov 21, 2014

There is no advantage to making pure C code. You'll need to either (1) program the Python interface by hand, which is not a fun task or (2) make Cython code to wrap the C code, which results in more Cython generated C code for the C code (you see where I'm going with this).

The only reason I can think of to have pure C code is if it is some legacy code that we want to wrap. Even then, it is probably easier to write new Cython code instead. And the licensing of legacy code is usually troublesome if there was no license or if it is GPL (we can't touch it if it is).

@leouieda leouieda added this to the 1.0 milestone Nov 21, 2014

@leouieda leouieda referenced this pull request Nov 21, 2014

Open

Mission statement #145

@leouieda

This comment has been minimized.

Member

leouieda commented Nov 21, 2014

Hi @leouieda, I found your text very clear and concise. I've one suggestion but far away to be relevant. Maybe put a link in "scope of the project" which points to a brief description already done (e.g, this overview https://github.com/fatiando/fatiando/blob/devel-guide/doc/index.rst) or another one more detailed (?).

That is a very good suggestion. We've been needing a nice and clear mission statement. Something like this for the khmer project.

I'll try to come up with a draft for that but I'll leave it for another PR (and another section of the docs). It might be better placed in the front page. I've opened #145 for this so we can move this particular discussion there.

leouieda added some commits Nov 21, 2014

Link to github guides page
They some really nice tutorials.
Separate branching into a new section
Added some more tips for getting started: look at issues, tell what
you're working on, low-hanging fruit.
@leouieda

This comment has been minimized.

Member

leouieda commented on doc/develop.rst in 19e5750 Nov 21, 2014

@hbueno I've replaced that broken link to a contributors graph from Github. Everyone should have access to this.

@coveralls

This comment has been minimized.

coveralls commented Nov 21, 2014

Coverage Status

Coverage remained the same when pulling 19e5750 on devel-guide into 246b4d7 on master.

@leouieda leouieda self-assigned this Nov 22, 2014

leouieda added some commits Nov 22, 2014

Mv docstring convs to Documentation
Reorder some things in the PR section as well.
@coveralls

This comment has been minimized.

coveralls commented Nov 22, 2014

Coverage Status

Coverage remained the same when pulling 4131244 on devel-guide into e0b1b95 on master.

@coveralls

This comment has been minimized.

coveralls commented Nov 23, 2014

Coverage Status

Coverage decreased (-0.01%) when pulling 6231643 on devel-guide into e0b1b95 on master.

@leouieda

This comment has been minimized.

Member

leouieda commented Nov 23, 2014

@hbueno any other suggestions for this? Just as a reminder, there is a compiled version on read the docs: http://fatiando.readthedocs.org/en/devel-guide/develop.html

@hbueno

This comment has been minimized.

Member

hbueno commented Nov 23, 2014

No, it's ok for me.

@leouieda

This comment has been minimized.

Member

leouieda commented Nov 23, 2014

Merging this then. If anything else comes up we can always open a new one.

leouieda added a commit that referenced this pull request Nov 23, 2014

Merge pull request #144 from fatiando/devel-guide
Completing the Developer Guide

@leouieda leouieda merged commit ff62132 into master Nov 23, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

@leouieda leouieda deleted the devel-guide branch Nov 23, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment