Skip to content
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

Simple getting started as a contributor docs #932

Closed
Christopher-Bradshaw opened this issue Jan 23, 2019 · 2 comments
Closed

Simple getting started as a contributor docs #932

Christopher-Bradshaw opened this issue Jan 23, 2019 · 2 comments
Assignees
Milestone

Comments

@Christopher-Bradshaw
Copy link
Contributor

Having not looked at halotools for a year or so, it took a bit of work to remember the code/test workflow that worked with .pyx files. The first time around, this also took me a while. In both cases I worked out that this did what I wanted:

python3 setup.py build_ext --inplace # if I changed a .pyx file
cd halotools
pytest [-s -k my_test_seach_string]

I'm sure this is very standard and people who work on large, compiled, python projects are probably very used to it. But having this (or a simpler workflow that you use) in a findable place might help new contributors.

@aphearin aphearin added this to the v0.7 milestone Jan 24, 2019
@aphearin
Copy link
Contributor

The developer docs are definitely lacking! I will be happy to add a new page of the docs dedicated to this. Will get to this before releasing v0.7.

@aphearin
Copy link
Contributor

aphearin commented Jan 7, 2020

New page added to the docs in #962.

@aphearin aphearin closed this as completed Jan 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants