Contribution Guidelines

[chrisgurney]

Proposal for a set of contribution guidelines and instructions for things.py

[chrisgurney]

@mikez @AlexanderWillner Ready for review! Of course, feel free to do with this what you wish!

Here it is with the markup, so it's easier to review the formatting:
https://github.com/chrisgurney/things.py/blob/main/CONTRIBUTING.md

[mikez]

@chrisgurney Looks great to me! 🥳

@AlexanderWillner What do you think?

[AlexanderWillner]

@AlexanderWillner What do you think?

Thanks a lot! Do you think we should add a warning to the section "Copy the test database to your Things app folder"? As this would overwrite your "production database" (i.e., your current database you're working with in Things.app)

[chrisgurney]

@AlexanderWillner

Thanks a lot! Do you think we should add a warning to the section "Copy the test database to your Things app folder"? As this would overwrite your "production database" (i.e., your current database you're working with in Things.app)

Good idea. I've added a warning in step 2 to make sure they've actually done step 1. 😀

⚠️ Before you proceed, make sure you've actually backed up your own personal database per step 1.

https://github.com/chrisgurney/things.py/blob/main/CONTRIBUTING.md

[AlexanderWillner]

Thanks, lgtm!

[mikez]

@chrisgurney I did some light editing for readability. Especially, I moved the instructions on how to edit the things database to the end, as in many cases this is not needed. Also, removed Windows-specific comments.

Do you think these edits make sense? Otherwise lgtm.

[chrisgurney]

@mikez Makes sense to me!