Some upkeeping #77
Merged
Some upkeeping #77
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 6, 2025
* remove src directory and move fsrs directory to top * add table of contents to README * link to CONTRIBUTING should link to gh hosted file so that link works on pypi page * make contributing instructions more concise
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I did a bit of upkeeping to help improve the repo a bit
srcdirectory and moved thefsrsdirectory to the top level of the repoThis is generally the more conventional way to structure a python package and it also allows users to easily import the
fsrsmodule directly rather than having to first do apip install .I also removed instructions telling contributors to bump the version number. I believe that bumping the version number is best left to maintainers when we decide to pack a new release.
Let me know if this looks alright 👍