rxswiftcommunity / rxswiftcommunity.github.io Goto Github PK

View Code? Open in Web Editor NEW

50.0 31.0 45.0 1.32 MB

For projects that support RxSwift

Home Page: http://community.rxswift.org

License: MIT License

Ruby 63.83% HTML 27.00% CSS 7.88% JavaScript 1.29%

rxswiftcommunity.github.io's Introduction

community.rxswift.org

Website for projects that support RxSwift.

Adding a new project

The site is generated from this file; add new projects there in YAML format.

When adding a new GitHub repository, there is no need to manually set stargazers, watchers or updated_at since these are updated automatically. Your basic "item" should look like so and be added to the appropriate section:

- name: YourProject
  repo: YourOrganization/YourProject
  description: A description of your project

If you get stuck, just open an issue!

Contributing

Fork the project.
Clone it locally.
Run bundle install
Use middleman and browse to localhost:4567 to preview changes.
Open a PR 🎉 targeting the source branch

Deploying

Deploying is handled automatically when a commit is made to the source branch.

Thanks

Thanks to this project for the bootstrap theme.

rxswiftcommunity.github.io's People

Contributors

Stargazers

Watchers

Forkers

ashfurrow thanegill carlosypunto esttorhe daichiro ruipfcosta icanzilb nathankot leopic devxoul reloni orakaro pgherveou groue nshoura oronbz beeth0ven sauravexodus wddwycc emenegro vbmania grafele khambir magi82 geektree0101 bmoliveira gumob laxmorek rashedakther takeratta lm2343635 bruce-pac maxvol gringoiredm luiyen cagricolak katoemba 87kangsw techinpark dev-jason-hwkim mustafagunes behrad-kzm mdo91 isabella232 iq-scm

rxswiftcommunity.github.io's Issues

Add repos from original issue

This is more of a "todo" once we have it figured out where/what this repo will be.

RxSwiftCommunity/contributors#5

Use Github pages

This is here for further discussion related using Github pages.

Flexboxification

Right now we use a kind of flowing grid to lay out all the cards on the site. That causes a problem when one card in a row is taller than the other cards in that row:

We should migrate our layout to use Flexbox, which presents an interface similar to UICollectionView for laying out items in a flow, line-breaking layout style. This will eliminate the gaps in between cards and their next rows.

Migrate to GitHub GraphQL API

The motivation for this is an issue (that GitHub claims as a feature) in their regular API.

You might or might not have noticed but the "last updated" date (By which the repos are sorted) isn't actually the date of the last pushed commit on master (or to the repo). This is very confusing since the field we're reading is actually pushed_at. When chatting with GitHub this was the response I got:

When a pull request is created, a hidden ref is created in the base repository to track that pull request. That hidden ref is automatically updated as the branch from which the pull request was created is updated.

Every one of these automatic update triggers a push. So any update to pull requests from forks will also update the pushed_at value for the base repository due to these hidden refs.

You can see these hidden refs mentioned here:

https://help.github.com/articles/checking-out-pull-requests-locally/#modifying-an-inactive-pull-request-locally

As it relates to your repository, it's likely that another user pushed commits to fork of that repository which subsequently updates the pushed_at value for this repository.

I agree that's confusing if you're trying to figure out how the pushed_at works. We have an internal issue open to see what the team thinks about this and if we'd consider changing this so that only pushes to user-defined branches and tags are counted towards the updated_at. I can't make any promises about this, but we'll followup with you when there's any news (I don't expect any news in the near future since changes like these are not that simple to make).

Besides, there are few more piece of information we would probably want to get for the community website later on.

Meaning, pushed_at isn't specific to only the repos, but also to its forks, which make the date unreliable.

Later, through this discussion, GH suggested we'd examine their GraphQL to pull the repo information with the top commit. I'll want to look into this later on but still not sure when.

Also, If the GraphQL API will still force us in doing two queries (one for the repo and one for the latest commit), it doesn't provide that much added value and we can keep using the regular API in this case .

Increase discoverability of projects with issues that need help

This continues discussion of #71, initially started by @pedrommcarrasco.

The TL;DR is - we need a good way to indicate to people if some projects have issues that need contributions. This helps the projects, but also helps contributors become more involved and pull in more new contributors.

Here is my proposed solution for this issue:

Mark issues with help wanted and good first issue. This is something anyone can definitely help with in the "moderation" side, if they have the time or just see an issue without a tag. This will also help on the GitHub side of things.

On the web side, have the script populate the number of issues as well, and then we can have a colored badge (red, orange, yellow, green) based on the number of open issues that need external help (for example green: 0, yellow, 0-3, orange: 3-10, red: >10, but we can experiment with these numbers later). If colors are scary we can go with some other visual indication :)

We can also add an explanation on the top of the page so people understand these badges, and they would link directly to the issues that need help (e.g. marked with these tags).

Since most issues don't have these tags used we might want to start with a version that counts all issues for a repo instead of just those with these specific tags, and later migrate to the tag-based solution when those become more common.

Would appreciate feedback from @RxSwiftCommunity/contributors if any :)
Shai.

This issue is about the next step here:

Activity of projects on GitHub is pretty much measured by stars (e.g. Stargazers)

This issue would be around someone who could add the relevant code to:

Query all Repos' stargazers_count off the GitHub API, e.g. https://api.github.com/repos/kzaher/RxFeedback
Sort the repositories either by resorting the YAML file, or sorting while the built HTML is generated

P.S.
GitHub has a rate limit over the search APIs so we might need to generate a GitHub token to make this work (its free and easy so no problems here)