search

jacob-macleod / Dolphin-Flashcard-App

http://www.dolphinflashcards.com
MIT License
1 stars 3 forks source link

PATCH: Goals.py documentation #126

Closed kenudeh closed 1 week ago

kenudeh commented 1 month ago

Hi, Jacob!

Please, review this documentation to see if there's anything to change.

I used 'number' and 'date' in the body parameter definitions to define data types where appropriate. Is that ok? or should I still use 'string' for all data types as before? Additionally, please confirm that XP stands for Experience Points because I defined it within the docs as such.

I'm so sorry I've been unable to do this all along, I've been engaged with something.

jacob-macleod commented 1 month ago

Thanks for your work on this! For the datatypes, that's fine for now. I'm working on a big database refactor to use a different and more scalable database system. I've been changing the datatypes, but as those changes aren't not merged yet, it's best to leave it as it is. I'll update the docs once I've finished the database refactor.

Changes in how you create a merge request

I've added some changes since you made the branch, which change how you make a merge request. Versioning and tagging is now handled automatically, but this means you need to:

Please could you update CHANGELOG.md and add a new entry for your changes? (Just add a brief message saying you've added documentation). This change is probably a minor change (it's not a patch, which is a very quick bugfix, and it's not a major change, which is usually some breaking change). So the new entry to add to the changelog will be version 2.4.0 (the last version is 2.3.1, and the middle number is incremented because it's a minor change.

The versioning follows semantic versioning, which has the convention MAJOR.MINOR.PATCH

I've updated the title of the merge request to add MINOR:, which tells the pipelines what change to expect so that it can check you've done the right thing.

Could you also change backend/__init__.py to set __version__ equal to the new version, 2.4.0? Thanks very much!

Thanks again for your work on this!

jacob-macleod commented 1 week ago

@kenudeh I've resolved the conflicts caused when I merged a big MR a day or two ago. I've also made those tweaks I mentioned in the comment (updating the CHANGELOG and init.py) Thanks for your work on this!

kenudeh commented 2 days ago

Alright, that's nice. Sorry I've not paid attention to this since making the PR.