Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

Getting started: Good first issues for new contributors #29

Open
7 tasks
Yinnerston opened this issue Jun 18, 2023 · 5 comments
Open
7 tasks

Getting started: Good first issues for new contributors #29

Yinnerston opened this issue Jun 18, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@Yinnerston
Copy link
Owner

Yinnerston commented Jun 18, 2023

Good First Issues

See the Jira for the entire list.

  • Integration testing for the backend. See src/backend/teaser/core/tests for example tests.
  • Add tutorials or other documentation from the codebase and notes
  • Bugfix get get_general_feed_service in src/backend/teaser/core/services/post_service.py. Currently it only gets posts that have been tagged, so to include all posts, a potential fix is to add an Untagged CategoriesModel and create a PostCategoriesModel foreign key relationship between an untagged post and the untagged category. Otherwise the get_general_feed_service can be rewritten for a NoSQL pattern.
  • Define a separate feed for logged in users in get_feed_for_you_service in src/backend/teaser/core/services/post_service.py.
  • Define backend endpoints to get all the liked and bookmarked posts by a user. Make a frontend screen for liked posts and bookmarked posts in the ProfileView
  • Implement some of the buttons in the UploadEditVideoScreen. See VideoToolsFooterNav
  • Implement 2FA with an authentication app
@Yinnerston Yinnerston added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Jun 18, 2023
@basu-10
Copy link

basu-10 commented Jun 20, 2023

Hi, i am very new to github. and was on the hunt for open source contributions, specifically "good first issues," when I stumbled upon this particular one in your repo. I happen to have experience with python, and I'm eager to jump right in and contribute. Can you guide me on how to get started?

@Yinnerston
Copy link
Owner Author

Yinnerston commented Jun 21, 2023

Hi, i am very new to github. and was on the hunt for open source contributions, specifically "good first issues," when I stumbled upon this particular one in your repo. I happen to have experience with python, and I'm eager to jump right in and contribute. Can you guide me on how to get started?

Of course, I'd love to help new contributors. The fact that you know python is good, you can work on the python backend.

How can python developers contribute?

Firstly, you need to make sure you can run the project on your own machine. There currently is no separation of development and production environments (see issue #32 ). I'm still working on getting this project ready for new contributors to run on their own machine.
Secondly, make sure you request to join the Jira. I'm primarily keeping track of assigning issues using Jira for now.
After you joined, assign an issue to yourself. I would recommend one of the issues above such as getting familiar with Teaser by writing basic tests for backend services like src/backend/teaser/core/services/search_service.py.
Thirdly, you need to familiarize yourself on how Django and Django Ninja work. I'd recommend reading through the django project documentation because the backend is built with Django Ninja.

Additional docs that might help:

[21/06/23] Is Teaser ready for open source contributors yet?

  • Honestly, no (blocked by Setting up a local dev environment #32 ) .
  • Currently, the frontend only has full functionality on Android.
  • I need to change the frontend code to work on a dev environment with a backend IP defined in the .frontend.env file.

TLDR: Still working on updating Teaser to work for open source contribution. You can assign issues to yourself but maybe check back in a week or two when #32 is completed.

@imnuvi
Copy link

imnuvi commented Jul 4, 2023

Hi @Yinnerston I have good experience with python,django. I can help you with the local setup or with any of the other issues. let me know and I can pick it up!

@Yinnerston Yinnerston removed the blocked label Jul 5, 2023
@Yinnerston
Copy link
Owner Author

Hi @cosmoglint , I think it's awesome that you've taken an interest in Teaser.

I've written down instructions on how to setup the project locally at #32 .

I want to work on other projects and uni right now, but I'm happy to review pull requests. Check the blog in the documentation for more details~.

@matheuslfarias
Copy link

Hi @Yinnerston, I would like to consistently contribute to the project. But all the projects I developed in python and django were personal projects without much glamor. If you're in a lot of mood and patience, I'd be very happy to help!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants