where is the ToDo list?

[vstadnytskyi]

I am the audience you guys made this package. I am a scientist that write a lot of codes but keeps all of them on my server. This project is very helpful for me.

I have seen some projects have ToDo list. However, I don't remember seen anything like that the folder create with Cookiecutter. Does it exist anywhere? Where do people usually put todo lists?

[mrakitin]

@vstadnytskyi, thanks for the question and your earlier contributions today. Feel free to create an issue with the requests/questions. I don't think we have a centralized TODO list for this project, but can review the existing issues from time to time and arrange priorities. Feel free to submit more PRs if you feel we are missing anything. Thanks!

[tacaswell]

This cookiecutter is mirroring out our opinionated version of how we work both at NSLS-II and within the broader scipy community. We tend to keep use github issues at TODOs rather than directly in the code. Issues are easier to read and comment on and everything we do is in the open.

That said, I am not opposed to putting a blank TODO file at the top level of the template.

[vstadnytskyi]

My question regarding the TODO list was not for the SciPy Cookiecutter project. I want to have my own to-do list for my projects and there is no example of good practices on how to organize it. Hence, I have asked what is the better way to organize TODO lists and if it would be wise to have a separate file in the template where scientists(including me) can put the TODO list. Or maybe, we can add a section in instruction on how to take care of TODO lists.

[danielballan]

More and more scipy projects are growing a "Roadmap" section in their documentation with a high-level summary of where they would like to focus and grow.

To pick one example: https://xarray.pydata.org/en/stable/roadmap.html

It might be worthwhile to survey a couple such examples and add a page to cookiecutter's documentation template.

[vstadnytskyi]

it is always nice to think about the bigger picture and where the project is going. It would also help new people to get involved in the project.

I have been heavily using this cookie-cutter for my project. It is nice to have documentation in a central place and it is easy to share some codes with other people.

A few things might be useful to add:

• how to add a package to Conda package manager.
• expand Travis settings to run tests in Mac/Linux/Windows
• add the reading list which will help people to better understand git and provide some guidelines in how and when to branch off, how to commit, how and when to create a pull request, etc.

I have expanded my Travis settings to test in different OS and different python versions.

I can take a stab at this since I had to figure out all the above for myself. This all can go into extra reading section for those who are interested.