loading...
Cover image for Contribute to Forem this Hacktoberfest!
The DEV Team

Contribute to Forem this Hacktoberfest!

coffeecraftcode profile image Christina Gorton ・3 min read

In honor of Hacktoberfest, the Forem team is actively looking for open source contributors to help improve our projects! The goal? To expand and improve Forem for the entire community while helping contributors achieve their four pull-request benchmark for Hacktoberfest!

Participants can use this list as a reference for the current projects Forem is seeking contributions on. 🎉

Projects

/resource_admin migrates to /admin

In the past, Forem has used two areas to take administrative action. As we continue to build out Forem, having two separate areas with similar functionality no longer makes sense, so we’ve been working towards consolidating the two admin panels.

We will be removing the administrate gem that powers resource_admin and want to bring all features into /admin.

Original Issue

Move Admin interface paths #9576

What type of PR is this? (check all applicable)

  • [x] Refactor
  • [ ] Feature
  • [ ] Bug Fix
  • [ ] Optimization
  • [x] Documentation Update

Description

Moves admin interfaces from /admin to /resource_admin in order the clear the way for future movement of /internal to /admin. See issue forem/InternalProjectPlanning#5 for more details!

Next steps will be to:

  • move /internal to /admin
  • remove administrate, and move these interfaces back up under /admin

Related Tickets & Documents

Part of forem/InternalProjectPlanning#5

Added tests?

  • [x] yes
  • [ ] no, because they aren't needed
  • [ ] no, because I need help

Added to documentation?

  • [x] docs.dev.to
  • [ ] readme
  • [ ] no documentation needed

[optional] What gif best describes this PR or how it makes you feel?

alt_text

Check out this GitHub Project for more issues related to this project.

API Improvements

An improved API enables more people to build on the Forem ecosystem!

Articles API: filtering by tags.

Articles API: filtering by tags #3654

Is your feature request related to a problem? Please describe.

Describe the solution you'd like In response to #3509, we want to allow the API endpoint to filter by tags and include an 'anti-tag' list.


API: Return properties regarding series in GET request data.

API: Return properties regarding series in GET request data #3669

Is your feature request related to a problem? Please describe.

When creating articles using the API, it's possible to assign the article to a series. However, when querying for articles from the API, no information regarding series is made available in either the objects returned /api/articles/?=${queryString} or the data returned from /api/articles/${id}.

Describe the solution you'd like

Ideally, a series property would be returned along with the rest of the data for each article from either endpoint with the title or some other identifier of the series to which the article belongs.

Describe alternatives you've considered

Additional context


Include video_source_url in the API.

Include video_source_url in the API #6299

Is your feature request related to a problem? Please describe.

Currently, the video_source_url field is not available for Videos in the API.

Describe the solution you'd like

Add the video_source_url to either the Video API or Articles API. The Video API would be my preference to prevent the need to query two API endpoints. But, either is workable.

Describe alternatives you've considered

Scraping the article for the video_source_url. But, I don't want to go down that route...


Breakdown Positive Reactions in the API.

Breakdown Positive Reactions in the API #6303

Is your feature request related to a problem? Please describe.

For building functionality into the Unofficial DEV Social Badge, it'd be nice to offer a breakdown of what the positive reactions are.

Describe the solution you'd like

Include the breakdown of the positive reactions in the articles API endpoints

Describe alternatives you've considered

Scraping. But, again, I don't want to go down that path.


Reading list API of an authenticated user

Reading list API of an authenticated user #6755

Is your feature request related to a problem? Please describe. Dev API doesn't have the option to list the authenticated user's reading list

Describe the solution you'd like Build an API to list user's reading list


Query organization on dev.to/api.

Query organization on dev.to/api #9212

Feature Request

Currently there in no way to query an organization on dev.to/api

Describe the solution you'd like

It would be nice to query https://dev.to/api/organization/articles, https://dev.to/api/organization/users, https://dev.to/api/organization/listings where organization is e.g., https://dev.to/api/vetswhocode

The description could read:

This endpoint allows the client to retrieve an organization .

"Organizations" is all the data that an organization creates on DEV that typically show up in the feed and a user is connected >to. They can be a blog post, a discussion question, a help thread etc. but is referred to as an organization within the code.

By default it will return featured, published articles ordered by descending date of publication

It supports pagination, each page will contain 30 articles by default.

Suggest or Implement a Liquid Tag!

Liquid tags have been a great differentiator and enhancement to our text editor. Now that we're expanding Forem to help power more communities, we'd love to introduce more liquid tags that aren't so developer-centric.

What kinds of tags would you like to see on Forem? Let us know in the comments!

Documentation

Good documentation is essential to the success and health of any open source project. If you see any issues, errors, or something you think should be added check out our “Contributing to the Docs” guidelines to contribute. A reminder that documentation changes should be a meaningful, value-add for the project.

Mobile Issues

If you are familiar with the Kotlin or Swift programming languages for mobile development, we have some open issues in our mobile app repositories. We would greatly appreciate contributions to make the experience of catching up with DEV on the go a little better for everyone.

Support for Ten X Hacker Theme in iOS app.

White Lines on Top and Bottom of App in Dark Mode #230

Describe the bug When using the app on iOS in dark mode, even though my phone is also on dark mode, the top and bottom "navbars" are of white color. Ruining the purpose of dark mode or theme.

Screen Shot attached: Screenshot 2020-09-21 at 2 20 39 PM To Reproduce Steps to reproduce the behavior:

Open Dev App on iOS Change the theme to dark mode, Note the top and bottom of the app is while,


README enhancements for iOS app.

Add steps on how to install the app on a physical iOS device #50

Is your feature request related to a problem? Please describe. Not really a problem, but a request to include steps on how to install the beta app on an actual device as opposed to in the macOS Simulator App.

Its been a long while since I've done any native development, and I had to relearn all the quirks of allowing a development stage app to be installed on my iPhone. I think this will be the case in the future if there are more people coming in from DEV.to to check out and install the app (like me 😜). I'd be happy to do this as a pull request for Hacktoberfest, if it's deemed a good idea! (This may become moot if everything is moved to TestFlight)

Describe the solution you'd like A step by step guide in the README on how to get the app working on a physical device. (Not too bloated, links to the "gotchya" steps that have already been documented many many times on StackOverflow and similar)

Describe alternatives you've considered This could be put somewhere else in the repository, but I think in the README makes the most sense.

Additional context N/A


Bump the minimum SDK for the Android app.

Bump the project minimum SDK API #88

Is your feature request related to a problem? Please describe.

Some initial attempts bumping the project minimum SDK API haven't been successful, but it's still an important thing we want to do in order to give a better experience to users since we do rely on some calls that are not supported in the current minimum (API 18).

Describe the solution you'd like

At the moment targeting support for API 21 and above feels like the right balance between reaching as many devices as possible while making sure we are installing in devices that will get a good experience. An example of this is that WebView's evaluateJavascript is only supported in API 19+ and we currently support a minimum 18 (which means they don't get Push Notifications and other features that rely on this).

Additional context

Contributions in the form of PRs are very welcome. Work on this issue may overlap with #87, just in case anyone is working on this it may be good to keep an eye on that one and see if conflicts may be avoided beforehand.


Remove highlight in Main Feed links from Android App.

Link highlighted #97

Describe the bug Through scrolling the news feed done links change there color without really clicking on them.

To Reproduce

  1. Go to news feed
  2. Scroll down
  3. Taping on link through scrolling (not enter)

Expected behavior Heighlght after kicking and entering the link.

Smartphone:

  • Device: Huawei P10
  • OS: Android
  • Version: 9

Add build flavors to Android app.

Project directory restructure (Build Flavors) #87

Is your feature request related to a problem? Please describe.

We've recently felt that the current project directory structure is a little too complex for our needs.

Our currently modular project directory (data, buildSrc, baseui, app) feels more appropriate for native apps that benefit from Activity/Fragment/ect reuse. In our case we deal with very few moving parts.

Describe the solution you'd like

We're open at the moment to contributions where we can simplify our project directory structure. The ideal result is a minimal directory structure where we can easily work on enhancing our main Main Activity & browsing experience with the custom WebViewClient.

The suggested changes that we're looking to see in a PR for this are the following:

[x] Simplified directory structure [x] Consider removal of databinding [x] Keep integrations we already have in the project (i.e. refreshVersions) [ ] Configuration of Build Flavors: To reduce contributors friction to spin up their local development and start working on the app we can provide a google-services.json dummy file for debug/development (read more about this)

Additional context

PR's for this issue are very welcome. If you have a question or want to suggest alternatives feel free to leave a comment in this issue. We are open to hearing ideas on how to make our directory a minimal version of what we currently have.


Bug with Notifications in Android app.

App always crashes when accessing from the notification area #95

For about a week now, dev.to Android app always crashes when accessed from push message, i.e. Notification Area, on Vivo.

Actually, the first ever notification message is Wisdom engine "DEV Community" runtime exception. After I slided to hide that message, this error consistently happen.

To Reproduce

  1. A notification message is received.
  2. Click on the notification message
  3. App opens and dies without any visible UI or message
  4. However, app can still be accessed via clicking the icon. (And the notification count is still there.)

Expected behavior

No crashes.

Smartphone (please complete the following information):

  • Device: vivo1910
  • OS: Android version 10 / vivo ROM Funtouch OS_10
  • Version: 1.4.1

Open Design Issues

If you prefer to flex your design skills check out this GitHub project card with open design issues


If you get stuck on what to work on, keep an eye out for our #hacktoberfest live-streams on Twitch! We’ll be holding these sessions on Mondays, Tuesdays and Thursdays throughout October where we’ll cover many of these projects and issues in more detail with different members of the Forem team.



See you on DEV and Twitch and Happy Hacktoberfest!

Discussion

pic
Editor guide
Collapse
ender_minyard profile image
ender minyard

I would like to contribute a developer centric liquid tag. Also, I'm learning Ruby to implement this tag so my pull request might need to be reviewed before being merged. Is that okay?

Collapse
coffeecraftcode profile image
Christina Gorton Author

Hey! Just be sure to check out our contributor guide if you haven't already and then go for it! Someone on the team will review it. I don't think it will be a problem if the tag is developer centric. Thanks for checking!

Collapse
ben profile image
Ben Halpern

We have a specific docs page for liquid tags, go for it!

docs.forem.com/frontend/liquid-tags/

Collapse
michaeltharrington profile image
Michael Tharrington (he/him)

Heyo!

I'm admittedly a non-developer, but on the DEV team. I'm sure that folks here would be happy to review your PR! And really cool to hear that you have an idea for a dev-centric liquid tag.

Collapse
leob profile image
leob

Cool! I wasn't even aware that you had mobile apps at all ... :-)