jonathanrocher / sprint_tutorial Goto Github PK

my_subtract should take two numbers and subtract the second from the first.

eg. my_subtract(5, 2) should return 3

Needs python setup.py develop in doc/how_to_sprint.rst.

Remove scipy from How To Create Development Environments step 4 "Add dependencies" in doc/how_to_sprint.rst That is, only install numpy (specific version) as a dependency.

In how_to_sprint.rst
-How to create development environments?
-Miniconda
-Step 3. Activate new envir.

Issue: 'source activate devenv' does not run in Windows. Only requires 'activate devenv'

my_product should take 2 values and multiply them.

Tutorial already pretty long, but mentioning it would be useful to provide people with tools if they want to help with test coverage.

I think we should enhance the readme file to be more useful.

nose
testing framework
doctest
unittest
styling tools

List testing frameworks, nose, pytest, doctest
other stuff
....

Right now tests for my_sum only test with integers. Would be good to add tests for array and mixed inputs.

my_sum(1, 1) didn't give me 2 as expected!

Steps to reproduce the problem.

There should be instructions to fork the repo.

What is a pull request ... ?? is a commit ... hope, expectation that someone pull's it into the repository? What is the language ... what is the feedback? an email .. or does a person revisit the package to see what maintainers do?

my_sum(2, 3) gave me 10. Should give me 5!

Remove these two unnecessary git commands from step 16 of The Typical Workflow in doc/how_to_sprint.rst:

git pull upstream master
git checkout fix/bug_name

(as stated by Jonathan Rocher as he presented the Sprint Tutorial at SciPy 2018 on 7/14/2018)

This is an idea .. a suggestion.

Start with modifying documents rather than a python program.

Use the github gui rather than trying to setup a devenv.

Try using the git command prompt. In windows it looks like bash.

I tried following your instructions ... using canopy command prompt. The edm commands worked, but after that I was lost. Ended in windows shell, at c:\users\userRoot

We should add commands following the sentence "Build the project into your dev environment. Run the test suite."

Package works great, but it could work better!

In how_to_sprint.rst under the title "How to create development environments?", the recommended code for activating new environment in Miniconda does not work for Windows. The Windows version of it should be just "activate devenv", no "source" in front. That is what worked for me, as a Windows user.

Instead, go back to just showing where the environment is.

List testing frameworks: unittest, nose, pytest, doctest, ...
Listing styling tools: pep8, flake8
...