Contributing

Thanks for your interest in todotxt.net! This is a brief guide that should help you if you're interested in contributing to the project.

Please note that the app is now in maintenance mode - bug fixes are welcome but new features will likely be rejected.

The best place to look for tasks that need doing is the github issues list. The issues labelled with Ready For Work ones that have been vetted and are ready to be worked on. Take a look through and see if anything interests you.

Before starting on a completely new feature, please create an issue to get approval from one of the maintainers. Unless we have pre-approved the work, it's likely that your change will not be accepted.

If you haven't set up your dev environment yet, Visual Studio Express is free and is all you need.

If you're not familiar with Git and Github, http://git-scm.com/book/en/Getting-Started-Git-Basics and https://help.github.com/articles/fork-a-repo are good places to start.

There are quite a few tests for the ToDoLib code (which interacts with the todo.txt file). If you make any changes to ToDoLib please make sure the existing tests pass and add in tests that cover your changes. For that you'll need NUnit.

Before you submit a pull request, please have a look at the diff of the files. If the entire file has been changed because of whitespace or formatting issues I'll reject the pull request. Unfortunately I've been burnt in the past by accepting code where significant bugs were hidden by a messy diff.

Please try and follow the general coding style in the app. It's not as consistent as I'd like as I've been fairly lenient in the requests I've accepted, but it should be (gradually!) improving.

Thanks again for your interest.