Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 SQLAlchemy Database Documentation #33

Open
tisuela opened this issue Oct 4, 2020 · 0 comments
Open

📝 SQLAlchemy Database Documentation #33

tisuela opened this issue Oct 4, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation hacktoberfest let's go Open Source! help wanted Extra attention is needed SQLAlchemy Python database CRUD library

Comments

@tisuela
Copy link
Owner

tisuela commented Oct 4, 2020

📝 CourseCake Database Documentation is incomplete

CourseCake uses SQLAlchemy for database models and CRUD operations. If you're familiar with it, or down to learn (pretty easy to pick up and is a useful skill), then this is for you.

Existing documentation is here

🔍 Where do I go for reference?

All database / SQLAlchemy related code lives here, in coursecake.database.

You'll want to focus on the CRUD operation in this file, coursecake.database.crud

Looking at the other existing docs will help, especially to understand the models.

🤷‍♀️ How do I contribute?

Fork this repository, and please restrict all changes to within the /docs directory. If you need to edit something outside of it (such as docstrings within coursecake.database) please comment here before submitting the final pull request.

@tisuela tisuela added documentation Improvements or additions to documentation help wanted Extra attention is needed hacktoberfest let's go Open Source! SQLAlchemy Python database CRUD library labels Oct 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest let's go Open Source! help wanted Extra attention is needed SQLAlchemy Python database CRUD library
Projects
None yet
Development

No branches or pull requests

1 participant